første xml update
[virt-orchestrator.git] / vFLOWER / content / Workflows / Library / vCenter / Virtual Machine management / Clone / Tools / Get NIC setting map.workflow.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <workflow xmlns="http://vmware.com/vco/workflow" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://vmware.com/vco/workflow http://vmware.com/vco/workflow/Workflow-v4.xsd" root-name="item3" object-name="Workflow:name=generic" id="BD80808080808080808080808080808094C280800122528313869552e41805bb1" version="0.2.0" api-version="3.1.0" allowed-operations="fv" restartMode="1" resumeFromFailedMode="0">
3     <display-name>Get NIC setting map</display-name>
4
5     <description>
6 Returns the setting map for virtual network card by using VimAdapterMapping.
7
8 Changes NIC information for workflows that clone and reconfigure virtual machines. Other clone workflows call this workflow.
9     </description>
10
11     <position x="160.0" y="10.0"/>
12
13     <input>
14         <param name="dhcp" type="boolean">
15             <description>Use a DHCP server to configure the virtual network adapter</description>
16         </param>
17         <param name="ipAddress" type="string">
18             <description>Fixed, valid IP address</description>
19         </param>
20         <param name="subnetMask" type="string">
21             <description>[Optional] Subnet mask for this virtual network adapter</description>
22         </param>
23         <param name="gateway" type="Array/string">
24             <description>[Optional] List of gateways, in order of preference</description>
25         </param>
26         <param name="dnsDomain" type="string">
27             <description>[Optional] DNS domain suffix, for example, vmware.com.</description>
28         </param>
29         <param name="dnsServerList" type="Array/string">
30             <description>[Optional] List of server IP addresses to use for DNS lookup in a Windows guest operating system</description>
31         </param>
32         <param name="netBIOS" type="VC:CustomizationNetBIOSMode">
33             <description>[Optional] NetBIOS setting for Windows</description>
34         </param>
35         <param name="primaryWINS" type="string">
36             <description>(Optional) IP address of the primary WINS server. Linux guest operating systems ignore this property</description>
37         </param>
38         <param name="secondaryWINS" type="string">
39             <description>(Optional) IP address of the secondary WINS server. Linux guest operating systems ignore this property</description>
40         </param>
41         <param name="macAddress" type="string">
42             <description>(Optional) MAC address of a network adapter to customize. By default, the customization process maps the settings from the virtual machine's network adapters, in PCI slot order</description>
43         </param>
44     </input>
45
46     <output>
47         <param name="adapterMapping" type="Any">
48             <description>Data object type to associate a virtual network adapter with its IP settings</description>
49         </param>
50     </output>
51
52     <attrib name="adapter" type="Any" read-only="false">
53         <value encoded="n">__NULL__</value>
54         <description>VimCustomizationIPSettings: IP settings for the associated virtual network adapter</description>
55     </attrib>
56     <attrib name="ip" type="Any" read-only="false">
57         <value encoded="n">__NULL__</value>
58         <description>VimCustomizationIpGenerator: Specification to obtain a unique IP address for this virtual network adapter</description>
59     </attrib>
60     <attrib name="exception" type="string" read-only="false">
61         <value encoded="n"/>
62         <description>Error code</description>
63     </attrib>
64     <workflow-note x="60.0" y="390.0" w="200.0" h="60.0" color="b0ebceff">
65         <description>Adapter Mapping</description>
66     </workflow-note>
67     <workflow-note x="60.0" y="320.0" w="200.0" h="50.0">
68         <description>IP Settings</description>
69     </workflow-note>
70     <workflow-note x="60.0" y="90.0" w="570.0" h="190.0">
71         <description>Choose the Correct IP Generator</description>
72     </workflow-note>
73
74     <workflow-item name="item0" type="end" end-mode="0">
75         <position x="160.0" y="470.0"/>
76     </workflow-item>
77
78     <workflow-item name="item1" out-name="item0" catch-name="item8" throw-bind-name="exception" type="task" script-module="com.vmware.library.vc.vm.spec.nic/getCustomizationAdapterMapping">
79         <display-name>getCustomizationAdapterMapping</display-name>
80
81         <script encoded="false">
82 //Auto generated script, cannot be modified !
83 actionResult = System.getModule("com.vmware.library.vc.vm.spec.nic").getCustomizationAdapterMapping(adapter,macAddress) ;
84         </script>
85
86         <in-binding>
87             <bind name="adapter" type="Any" export-name="adapter">
88                 <description>VimCustomizationIPSettings: The IP settings for the associated virtual network adapter.</description>
89             </bind>
90             <bind name="macAddress" type="string" export-name="macAddress">
91                 <description>[Optional] The MAC address of a network adapter being customized. If it is not included, the customization process maps the settings from the virtual machine's network adapters, in PCI slot order.</description>
92             </bind>
93         </in-binding>
94
95         <out-binding>
96             <bind name="actionResult" type="Any" export-name="adapterMapping"/>
97         </out-binding>
98
99         <description>Define Data object type to associate a virtual network adapter with its IP settings.</description>
100
101         <position x="120.0" y="420.0"/>
102     </workflow-item>
103
104     <workflow-item name="item2" out-name="item1" catch-name="item8" throw-bind-name="exception" type="task" script-module="com.vmware.library.vc.vm.spec.nic/getCustomizationIPSettings">
105         <display-name>getCustomizationIPSettings</display-name>
106
107         <script encoded="false">
108 //Auto generated script, cannot be modified !
109 actionResult = System.getModule("com.vmware.library.vc.vm.spec.nic").getCustomizationIPSettings(dnsDomain,dnsServerList,gateway,ip,netBIOS,primaryWINS,secondaryWINS,subnetMask) ;
110         </script>
111
112         <in-binding>
113             <bind name="dnsDomain" type="string" export-name="dnsDomain">
114                 <description>[Optional] A DNS domain suffix such as dunes.ch.</description>
115             </bind>
116             <bind name="dnsServerList" type="Array/string" export-name="dnsServerList">
117                 <description>[Optional] A list of server IP addresses to use for DNS lookup in a Windows guest operating system.</description>
118             </bind>
119             <bind name="gateway" type="Array/string" export-name="gateway">
120                 <description>[Optional] List of gateways, in order of preference.</description>
121             </bind>
122             <bind name="ip" type="Any" export-name="ip">
123                 <description>VimCustomizationIpGenerator: Specification to obtain a unique IP address for this virtual network adapter.</description>
124             </bind>
125             <bind name="netBIOS" type="VC:CustomizationNetBIOSMode" export-name="netBIOS">
126                 <description>[Optional] NetBIOS setting for Windows.</description>
127             </bind>
128             <bind name="primaryWINS" type="string" export-name="primaryWINS">
129                 <description>[Optional] The IP address of the primary WINS server. This property is ignored for Linux guest operating systems.</description>
130             </bind>
131             <bind name="secondaryWINS" type="string" export-name="secondaryWINS">
132                 <description>[Optional] The IP address of the secondary WINS server. This property is ignored for Linux guest operating systems.</description>
133             </bind>
134             <bind name="subnetMask" type="string" export-name="subnetMask">
135                 <description>[Optional] Subnet mask for this virtual network adapter.</description>
136             </bind>
137         </in-binding>
138
139         <out-binding>
140             <bind name="actionResult" type="Any" export-name="adapter"/>
141         </out-binding>
142
143         <description>Define IP settings for a virtual network adapter.</description>
144
145         <position x="120.0" y="340.0"/>
146     </workflow-item>
147
148     <workflow-item name="item3" out-name="item4" type="condition" alt-out-name="item6" comparator="0">
149         <display-name>DHCP?</display-name>
150
151         <script encoded="false">
152 //Generated by the system, cannot be edited
153 return (dhcp == true) ;
154         </script>
155
156         <in-binding>
157             <bind name="dhcp" type="boolean" export-name="dhcp"/>
158         </in-binding>
159         <condition name="dhcp" type="boolean" comparator="0" label="null">false</condition>
160
161         <position x="120.0" y="130.0"/>
162     </workflow-item>
163
164     <workflow-item name="item4" out-name="item2" type="task" script-module="com.vmware.library.vc.vm.spec.nic/getCustomizationDhcpIpGenerator">
165         <display-name>getCustomizationDhcpIpGenerator</display-name>
166
167         <script encoded="false">
168 //Auto generated script, cannot be modified !
169 actionResult = System.getModule("com.vmware.library.vc.vm.spec.nic").getCustomizationDhcpIpGenerator() ;
170         </script>
171
172         <in-binding/>
173
174         <out-binding>
175             <bind name="actionResult" type="Any" export-name="ip"/>
176         </out-binding>
177
178         <description>Use a DHCP server to configure the virtual network adapter.</description>
179
180         <position x="120.0" y="200.0"/>
181     </workflow-item>
182
183     <workflow-item name="item5" out-name="item2" catch-name="item8" throw-bind-name="exception" type="task" script-module="com.vmware.library.vc.vm.spec.nic/getCustomizationFixedIp">
184         <display-name>getCustomizationFixedIp</display-name>
185
186         <script encoded="false">
187 //Auto generated script, cannot be modified !
188 actionResult = System.getModule("com.vmware.library.vc.vm.spec.nic").getCustomizationFixedIp(ipAddress) ;
189         </script>
190
191         <in-binding>
192             <bind name="ipAddress" type="string" export-name="ipAddress"/>
193         </in-binding>
194
195         <out-binding>
196             <bind name="actionResult" type="Any" export-name="ip"/>
197         </out-binding>
198
199         <description>Use a static IP Address for the virtual network adapter.</description>
200
201         <position x="300.0" y="200.0"/>
202     </workflow-item>
203
204     <workflow-item name="item6" out-name="item5" type="custom-condition" alt-out-name="item7">
205         <display-name>Fixed IP?</display-name>
206
207         <script encoded="false">
208 return ipAddress != null &amp;&amp; ipAddress != "";
209         </script>
210
211         <in-binding>
212             <bind name="ipAddress" type="string" export-name="ipAddress"/>
213         </in-binding>
214
215         <position x="300.0" y="130.0"/>
216     </workflow-item>
217
218     <workflow-item name="item7" out-name="item2" type="task" script-module="com.vmware.library.vc.vm.spec.nic/getCustomizationUnknownIpGenerator">
219         <display-name>getCustomizationUnknownIpGenerator</display-name>
220
221         <script encoded="false">
222 //Auto generated script, cannot be modified !
223 actionResult = System.getModule("com.vmware.library.vc.vm.spec.nic").getCustomizationUnknownIpGenerator() ;
224         </script>
225
226         <in-binding/>
227
228         <out-binding>
229             <bind name="actionResult" type="Any" export-name="ip"/>
230         </out-binding>
231
232         <description>The IP address is left unspecified. The user must be prompted to supply an IP address.</description>
233
234         <position x="480.0" y="200.0"/>
235     </workflow-item>
236
237     <workflow-item name="item8" out-name="item9" type="task">
238         <display-name>Add text to exception</display-name>
239
240         <script encoded="false">
241 exception = "Unable to create Nic Setting Map: " + exception;
242         </script>
243
244         <in-binding>
245             <bind name="exception" type="string" export-name="exception"/>
246         </in-binding>
247
248         <out-binding>
249             <bind name="exception" type="string" export-name="exception"/>
250         </out-binding>
251
252         <position x="360.0" y="340.0"/>
253     </workflow-item>
254
255     <workflow-item name="item9" throw-bind-name="exception" type="end" end-mode="1">
256         <position x="520.0" y="330.0"/>
257     </workflow-item>
258
259     <presentation>
260         <p-param name="macAddress">
261             <desc>(Optional) MAC address of a network adapter to customize. By default, the customization process maps the settings from the virtual machine's network adapters, in PCI slot order</desc>
262             <p-qual kind="static" name="regexp" type="Regexp">00:50:56:[0-3][0-9A-Fa-f](:[0-9A-Fa-f]{2}){2}</p-qual>
263         </p-param>
264         <p-param name="dnsDomain">
265             <desc>(Optional) DNS domain suffix, for example, vmware.com</desc>
266         </p-param>
267         <p-param name="dnsServerList">
268             <desc>(Optional) List of server IP addresses to use for DNS lookup in a Windows guest operating system.</desc>
269         </p-param>
270         <p-param name="gateway">
271             <desc>(Optional) List of gateways, in order of preference.</desc>
272         </p-param>
273         <p-param name="netBIOS">
274             <desc>(Optional) NetBIOS setting for Windows.</desc>
275         </p-param>
276         <p-param name="primaryWINS">
277             <desc>(Optional)IP address of the primary WINS server. Linux guest operating systems ignore this property</desc>
278         </p-param>
279         <p-param name="secondaryWINS">
280             <desc>(Optional) IP address of the secondary WINS server. Linux guest operating systems ignore this property</desc>
281         </p-param>
282         <p-param name="subnetMask">
283             <desc>(Optional) Subnet mask for this virtual network adapter</desc>
284         </p-param>
285         <p-param name="dhcp">
286             <desc>Use a DHCP server to configure the virtual network adapter?</desc>
287         </p-param>
288         <p-param name="ipAddress">
289             <desc>Fixed, valid IP address</desc>
290         </p-param>
291     </presentation>
292 </workflow>