Skip to content

Commit 8db8ee7

Browse files
radhikapke4qqq
radhikap
authored and
ke4qqq
committed
dev guide updates for 4.1
Signed-off-by: radhikap <radhika.puthiyetath@citrix.com>
1 parent fe44e39 commit 8db8ee7

5 files changed

Lines changed: 252 additions & 33 deletions

File tree

‎docs/en-US/added-API-commands-4-1.xml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="added-API-commands-4.1">
22+
<title>Added API Commands in 4.1-incubating</title>
23+
<itemizedlist>
24+
<listitem>
25+
<para>createEgressFirewallRules (creates an egress firewall rule on the guest network.)</para>
26+
</listitem>
27+
<listitem>
28+
<para>deleteEgressFirewallRules (deletes a egress firewall rule on the guest network.)</para>
29+
</listitem>
30+
<listitem>
31+
<para>listEgressFirewallRules (lists the egress firewall rules configured for a guest
32+
network.)</para>
33+
</listitem>
34+
<listitem>
35+
<para>resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.)</para>
36+
</listitem>
37+
<listitem>
38+
<para>addBaremetalHost (Adds a new host.)</para>
39+
</listitem>
40+
</itemizedlist>
41+
</section>

‎docs/en-US/changed-apicommands-4.1.xml‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="changed-apicommands-4.1">
22+
<title>Changed API Commands in 4.1-incubating</title>
23+
<informaltable>
24+
<tgroup cols="2" align="left" colsep="1" rowsep="1">
25+
<colspec colwidth="1.0*" colname="1" colnum="1"/>
26+
<colspec colwidth="4.37*" colname="2" colnum="2"/>
27+
<thead>
28+
<row>
29+
<entry><para>API Commands</para></entry>
30+
<entry><para>Description</para></entry>
31+
</row>
32+
</thead>
33+
<tbody>
34+
<row>
35+
<entry>
36+
<para>createNetworkOffering</para>
37+
<para>listNetworkOfferings</para>
38+
<para>listNetworks</para>
39+
</entry>
40+
<entry>
41+
<para>The following request parameters is added: isPersistent.</para>
42+
<para>This parameter determines if the network or network offering created or listed by
43+
using this offering are persistent or not.</para>
44+
</entry>
45+
</row>
46+
<row>
47+
<entry>
48+
<para>addF5LoadBalancer</para>
49+
<para>configureNetscalerLoadBalancer</para>
50+
<para>addNetscalerLoadBalancer</para>
51+
<para>listF5LoadBalancers</para>
52+
<para>configureF5LoadBalancer</para>
53+
<para>listNetscalerLoadBalancers</para>
54+
</entry>
55+
<entry>
56+
<para>The following response parameter is removed: inline.</para>
57+
</entry>
58+
</row>
59+
<row>
60+
<entry><para>listFirewallRules</para>
61+
<para>createFirewallRule</para></entry>
62+
<entry>
63+
<para>The following request parameter is added: traffictype (optional).</para>
64+
</entry>
65+
</row>
66+
<row>
67+
<entry><para>listUsageRecords</para></entry>
68+
<entry><para>The following response parameter is added: virtualsize.</para>
69+
</entry>
70+
</row>
71+
<row>
72+
<entry>
73+
<para>deleteIso</para>
74+
</entry>
75+
<entry>
76+
<para>The following request parameter is added: forced (optional).</para>
77+
</entry>
78+
</row>
79+
<row>
80+
<entry>
81+
<para>createStoragePool</para>
82+
</entry>
83+
<entry>
84+
<para>The following request parameters are made mandatory:</para>
85+
<itemizedlist>
86+
<listitem>
87+
<para>podid</para>
88+
</listitem>
89+
<listitem>
90+
<para>clusterid</para>
91+
</listitem>
92+
</itemizedlist>
93+
</entry>
94+
</row>
95+
<row>
96+
<entry>
97+
<para>listZones</para>
98+
</entry>
99+
<entry>
100+
<para>The following request parameters is added: securitygroupenabled</para>
101+
</entry>
102+
</row>
103+
</tbody>
104+
</tgroup>
105+
</informaltable>
106+
</section>

‎docs/en-US/reset-ssh-key-dev.xml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="reset-ssh-key-dev">
22+
<title>Resetting SSH Keys to Access VMs</title>
23+
<para>Use the resetSSHKeyForVirtualMachine API to set or reset the SSH keypair assigned to a
24+
virtual machine. With the addition of this feature, a lost or compromised SSH keypair can be
25+
changed, and the user can access the VM by using the new keypair. Just create or register a new
26+
keypair, then call resetSSHKeyForVirtualMachine.</para>
27+
</section>

‎docs/en-US/vmx-settings-dev.xml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="vmx-settings-dev">
22+
<title>Additional VMX Settings</title>
23+
<para>A VMX (.vmx) file is the primary configuration file for a virtual machine. When a new VM is
24+
created, information on the operating system, disk sizes, and networking is stored in this file.
25+
The VM actively writes to its .vmx file for all the configuration changes. The VMX file is
26+
typically located in the directory where the VM is created. In Windows Vista / Windows 7 /
27+
Windows Server 2008, the default location is C:\Users\&lt;your_user_name&gt;\My
28+
Documents\Virtual Machines\&lt;virtual_machine_name&gt;.vmx. In Linux, vmware-cmd -l lists the
29+
full path to all the registered VMX files. Any manual additions to the .vmx file from ESX/ESXi
30+
are overwritten by the entries stored in the vCenter Server database. Therefore, before you edit
31+
a .vmx file, first remove the VM from the vCenter server's inventory and register the VM again
32+
after editing.</para>
33+
<para>The CloudStack API that supports passing some of the VMX settings is registerTemplate. The
34+
supported parameters are rootDiskController, nicAdapter, and keyboard. In addition to these
35+
existing VMX parameters, you can now use the keyboard.typematicMinDelay parameter in the
36+
registerTemplate API call. This parameter controls the amount of delay for the repeated key
37+
strokes on remote consoles. For more information on keyboard.typematicMinDelay, see <ulink
38+
url=" http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&amp;cmd=displayKC&amp;externalId=196"
39+
>keyboard.typematicMinDelay</ulink>.</para>
40+
</section>

‎docs/en-US/whats-new.xml‎

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,45 @@
33
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
44
%BOOK_ENTITIES;
55
]>
6-
76
<!-- Licensed to the Apache Software Foundation (ASF) under one
8-
or more contributor license agreements. See the NOTICE file
9-
distributed with this work for additional information
10-
regarding copyright ownership. The ASF licenses this file
11-
to you under the Apache License, Version 2.0 (the
12-
"License"); you may not use this file except in compliance
13-
with the License. You may obtain a copy of the License at
14-
15-
http://www.apache.org/licenses/LICENSE-2.0
16-
17-
Unless required by applicable law or agreed to in writing,
18-
software distributed under the License is distributed on an
19-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20-
KIND, either express or implied. See the License for the
21-
specific language governing permissions and limitations
22-
under the License.
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
2320
-->
24-
2521
<chapter id="whats-new">
26-
<title>What's New in the API?</title>
27-
<para>The following describes any new major features of each &PRODUCT; version as it applies to API usage.</para>
28-
<section id="whats-new-in-api-4.0">
29-
<title>What's New in the API for 4.0</title>
30-
<xi:include href="changed-apicommands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
31-
<xi:include href="added-API-commands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
32-
</section>
33-
<section id="whats-new-in-api-3.0">
34-
<title>What's New in the API for 3.0</title>
35-
<xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
36-
<xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
37-
<xi:include href="change-to-behavior-of-list-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
38-
<xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
39-
<xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
40-
<xi:include href="added-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
41-
</section>
22+
<title>What's New in the API?</title>
23+
<para>The following describes any new major features of each &PRODUCT; version as it applies to
24+
API usage.</para>
25+
<section id="whats-new-in-api-4.1">
26+
<title>What's New in the API for 4.1</title>
27+
<xi:include href="vmx-settings-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
28+
<xi:include href="reset-ssh-key-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
29+
<xi:include href="changed-apicommands-4.1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
30+
<xi:include href="added-API-commands-4-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
31+
</section>
32+
<section id="whats-new-in-api-4.0">
33+
<title>What's New in the API for 4.0</title>
34+
<xi:include href="changed-apicommands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
35+
<xi:include href="added-API-commands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
36+
</section>
37+
<section id="whats-new-in-api-3.0">
38+
<title>What's New in the API for 3.0</title>
39+
<xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
40+
<xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
41+
<xi:include href="change-to-behavior-of-list-commands.xml"
42+
xmlns:xi="http://www.w3.org/2001/XInclude"/>
43+
<xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
44+
<xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
45+
<xi:include href="added-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
46+
</section>
4247
</chapter>

0 commit comments

Comments
 (0)