7c37458488e587f4cfa82bcf457dc09d1b78a28d
[ccsdk/cds.git] /
1 {\r
2   "description": "This is Netconf Transaction Configuration Component API",\r
3   "version": "1.0.0",\r
4   "capabilities": {\r
5     "component-node": {\r
6       "type": "tosca.capabilities.Node"\r
7     }\r
8   },\r
9   "requirements": {\r
10     "netconf-connection": {\r
11       "capability": "netconf",\r
12       "node": "vnf-netconf-device",\r
13       "relationship": "tosca.relationships.ConnectsTo"\r
14     }\r
15   },\r
16   "interfaces": {\r
17     "org-openecomp-sdnc-netconf-adaptor-service-NetconfTransactionNode": {\r
18       "operations": {\r
19         "process": {\r
20           "inputs": {\r
21             "rollback": {\r
22               "required": false,\r
23               "type": "boolean"\r
24             },\r
25             "assignment-action-name": {\r
26               "description": "Assignment Action Name to get from Database, Either (message & mask-info ) or ( resource-id & resource-type & action-name & template-name ) should be present. Message will be given higest priority",\r
27               "required": true,\r
28               "type": "string"\r
29             },\r
30             "transaction-components": {\r
31               "description": "Components used to used for the atomic transaction, Default Handlers are org.openecomp.sdnc.netconf.adaptor.service.SimpleNetconfEditConfigNode and org.openecomp.sdnc.netconf.adaptor.service.SimpleNetconfGetConfigNode",\r
32               "required": true,\r
33               "type": "list",\r
34               "entry_schema": {\r
35                 "type": "string"\r
36               }\r
37             },\r
38             "resource-type": {\r
39               "description": "Resource Type to get from Database, Either (message & mask-info ) or( resource-id & resource-type & action-name & template-name ) should be present. Message will be given higest priority",\r
40               "required": false,\r
41               "type": "string"\r
42             },\r
43             "initialise-sftp": {\r
44               "required": false,\r
45               "type": "boolean"\r
46             },\r
47             "request-id": {\r
48               "description": "Request Id used to store the generated configuration, in the database along with the template-name",\r
49               "required": true,\r
50               "type": "string"\r
51             },\r
52             "initialise-ssh": {\r
53               "required": false,\r
54               "type": "boolean"\r
55             },\r
56             "lock": {\r
57               "required": false,\r
58               "type": "boolean",\r
59               "default": false\r
60             },\r
61             "unlock": {\r
62               "description": "If unLock command has to send before Edit Configuration.",\r
63               "required": false,\r
64               "type": "boolean",\r
65               "default": false\r
66             },\r
67             "resource-id": {\r
68               "description": "Resource Id to get from Database, Either (message & mask-info ) or ( resource-id & resource-type & action-name & template-name ) should be present. Message will be given higest priority",\r
69               "required": false,\r
70               "type": "string"\r
71             },\r
72             "action-name": {\r
73               "description": "Action Name to get from Database, Either (message & mask-info ) or ( resource-id & resource-type & action-name & template-name ) should be present. Message will be given higest priority",\r
74               "required": false,\r
75               "type": "string"\r
76             }\r
77           },\r
78           "outputs": {\r
79             "rpc-response-message": {\r
80               "type": "string"\r
81             },\r
82             "status": {\r
83               "description": "Status of the Component Execution ( success or failure )",\r
84               "required": true,\r
85               "type": "string"\r
86             }\r
87           }\r
88         }\r
89       }\r
90     }\r
91   },\r
92   "derived_from": "tosca.nodes.Component"\r
93 }