Updating docs to match new images / api params

Author: davidjumani

source/adminguide/backup_and_recovery.rst

@@ -12,7 +12,7 @@
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
- 
+
 About Backup And Recovery
 --------------------------
 
@@ -41,7 +41,7 @@ Backup and recovery has been designed to support two modes:
 - Adhoc and user scheduled backups
 
 'SLA' based backups are ones where the Cloud provider (ie the root admin) controls the time, and frequency of a backup scheme.
-A user signs up for a 'Gold' offering, which might give them a RPO of 12 hours and the last 14 backups kept; however the user would not be 
+A user signs up for a 'Gold' offering, which might give them a RPO of 12 hours and the last 14 backups kept; however the user would not be
 allowed to perform additional backups nor set the exact time that these backups took place.  The user might be charged
 a fix rate for these backups regardless of the size of the backups.
 
@@ -89,7 +89,7 @@ backups. Users can list and consume the imported backup offerings, only root adm
 delete offerings.
 
 Supported APIs:
-~~~~~~~~~~~~~~~~ 
+~~~~~~~~~~~~~~~~
 
 - **listBackupProviders**: lists available backup provider plugins
 - **listBackupProviderOfferings**: lists external backup policy/offering from a provider
@@ -109,18 +109,18 @@ To import a backup provider offering;
 #. Enter your user-friendly name and description and select the applicable zone.  The External ID will then be populated with the
    template jobs which CloudStack retrieves from the connected provider.
 
-   |B&R-backup_offering_policy.jpg|  |B&R-backup_offering.jpg|
+   |B&R-backup_offering_policy.png|  |B&R-backup_offering.png|
 
 Creating VM Backups
 ---------------------
 
 SLA/Policy Based backups
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-With the backup and recovery feature enabled for a zone, users simply add and 
+With the backup and recovery feature enabled for a zone, users simply add and
 remove a VM from a backup offering.
 
-|B&R-assignOffering.jpg|
+|B&R-assignOffering.png|
 
 Adhoc and Scheduled Backups
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -133,16 +133,16 @@ allowed to add/remove volumes similar to VM snapshots.
 To trigger an adhoc backup of a VM, navigate to the instance and click on the 'Create Backup'
 icon.
 
-|B&R-createBackup.jpg|
+|B&R-createBackup.png|
 
 To setup a recurring backup schedule, navigate to the instance and click on the 'Backup Schedule'
 icon.
 
-|B&R-BackupSchedule.jpg|
+|B&R-BackupSchedule.png|
 
 Then set the time and frequency of the backups, click 'Configure' and then 'Close'
 
-|B&R-BackupScheduleEntry.jpg|
+|B&R-BackupScheduleEntry.png|
 
 Restoring VM Backups
 ---------------------
@@ -169,21 +169,21 @@ Supported APIs:
 - **restoreVolumeFromBackup**: restore and attach a backed-up volume (of a VM backup) to a specified VM.
 
 
-.. |B&R-assignOffering.jpg| image:: /_static/images/B&R-assignOffering.jpg
+.. |B&R-assignOffering.png| image:: /_static/images/B&R-assignOffering.png
    :alt: Assigning an SLA/Policy to a VM.
    :width: 400 px
-.. |B&R-backup_offering_policy.jpg| image:: /_static/images/B&R-backup_offering_policy.jpg
+.. |B&R-backup_offering_policy.png| image:: /_static/images/B&R-backup_offering_policy.png
    :alt: Importing an SLA/Policy offering.
    :width: 300 px
-.. |B&R-backup_offering.jpg| image:: /_static/images/B&R-backup_offering.jpg
+.. |B&R-backup_offering.png| image:: /_static/images/B&R-backup_offering.png
    :alt: Importing a template backup offering.
    :width: 300 px
-.. |B&R-createBackup.jpg| image:: /_static/images/B&R-createBackup.jpg
+.. |B&R-createBackup.png| image:: /_static/images/B&R-createBackup.png
    :alt: Triggering an adhoc backup for a VM.
    :width: 400 px
-.. |B&R-BackupSchedule.jpg| image:: /_static/images/B&R-BackupSchedule.jpg
+.. |B&R-BackupSchedule.png| image:: /_static/images/B&R-BackupSchedule.png
    :alt: Creating a backup schedule for a VM.
    :width: 400 px
-.. |B&R-BackupScheduleEntry.jpg| image:: /_static/images/B&R-BackupScheduleEntry.jpg
+.. |B&R-BackupScheduleEntry.png| image:: /_static/images/B&R-BackupScheduleEntry.png
    :alt: Creating a backup schedule for a VM.
    :width: 400px

source/adminguide/networking.rst

@@ -59,7 +59,7 @@ account. Isolated networks have the following properties.
 -  The network offering can be upgraded or downgraded but it is for the
    entire network
 
-For more information, see `“Configure Guest Traffic in an Advanced Zone” 
+For more information, see `“Configure Guest Traffic in an Advanced Zone”
 <networking_and_traffic.html#configure-guest-traffic-in-an-advanced-zone>`_.
 
 
@@ -84,7 +84,7 @@ Basic zones in CloudStack 3.0.3 and later versions.
 
 -  Source NAT per zone is not supported in Shared Network when the
    service provider is virtual router. However, Source NAT per account
-   is supported. For information, see `“Configuring a Shared Guest 
+   is supported. For information, see `“Configuring a Shared Guest
    Network” <networking_and_traffic.html#configuring-a-shared-guest-network>`_.
 
 
@@ -93,7 +93,7 @@ L2 Networks
 
 L2 networks provide network isolation without any other services.  This
 means that there will be no virtual router.  It is assumed that the end
-user will have their own IPAM in place, or that they will statically assign 
+user will have their own IPAM in place, or that they will statically assign
 IP addresses.
 
 -  L2 networks can be created by the end users, however network offerings
@@ -107,7 +107,7 @@ IP addresses.
 
 Example GUI dialog box (for a regular user account) is shown below:
 
-|L2-networks-gui.JPG|
+|L2-networks-gui.png|
 
 
 Runtime Allocation of Virtual Network Resources
@@ -124,8 +124,8 @@ helps to conserve network resources.
 Network Service Providers
 -------------------------
 
-.. note:: 
-   For the most up-to-date list of supported network service providers, 
+.. note::
+   For the most up-to-date list of supported network service providers,
    see the CloudStack UI or call `listNetworkServiceProviders`.
 
 A service provider (also called a network element) is hardware or
@@ -179,8 +179,8 @@ offering.
 Network Offerings
 -----------------
 
-.. note:: 
-   For the most up-to-date list of supported network services, see the 
+.. note::
+   For the most up-to-date list of supported network services, see the
    CloudStack UI or call listNetworkServices.
 
 A network offering is a named set of network services, such as:
@@ -220,12 +220,12 @@ running a web server farm and require a scalable firewall solution, load
 balancing solution, and alternate networks for accessing the database
 backend.
 
-.. note:: 
-   If you create load balancing rules while using a network service 
-   offering that includes an external load balancer device such as 
-   NetScaler, and later change the network service offering to one that 
-   uses the CloudStack virtual router, you must create a firewall rule 
-   on the virtual router for each of your existing load balancing rules 
+.. note::
+   If you create load balancing rules while using a network service
+   offering that includes an external load balancer device such as
+   NetScaler, and later change the network service offering to one that
+   uses the CloudStack virtual router, you must create a firewall rule
+   on the virtual router for each of your existing load balancing rules
    so that they continue to function.
 
 When creating a new virtual network, the CloudStack administrator
@@ -298,9 +298,9 @@ To create a network offering:
       following supported services:
 
       .. cssclass:: table-striped table-bordered table-hover
-      
+
       =================== ============================================================================ ============= =============
-      Supported Services  Description                                                                  Isolated      Shared   
+      Supported Services  Description                                                                  Isolated      Shared
       =================== ============================================================================ ============= =============
       DHCP                For more information, see `“DNS and                                          Supported     Supported
                           DHCP” <networking_and_traffic.html#dns-and-dhcp>`_.
@@ -340,7 +340,7 @@ To create a network offering:
       system service offering and any custom system service offerings
       that have been defined by the CloudStack root administrator.
 
-      For more information, see `“System Service Offerings” 
+      For more information, see `“System Service Offerings”
       <service_offerings.html#system-service-offerings>`_.
 
    -  **LB Isolation**: Specify what type of load balancer isolation you
@@ -371,7 +371,7 @@ To create a network offering:
          balancing traffic to the load balancer behind it. The load
          balancer in this case will not have the direct access to the
          public network.
-  
+
       -  **Side by Side**: In side by side mode, a firewall device is
          deployed in parallel with the load balancer device. So the traffic
          to the load balancer public IP is not routed through the firewall,
@@ -386,7 +386,7 @@ To create a network offering:
 
       -  Elastic IP is enabled.
 
-      For information on Elastic IP, see `“About Elastic IP” 
+      For information on Elastic IP, see `“About Elastic IP”
       <networking/elastic_ips.html>`_.
 
    -  **Redundant router capability**: Available only when Virtual
@@ -409,10 +409,10 @@ To create a network offering:
       the conserve mode is on, you can define more than one service on
       the same public IP.
 
-      .. note:: 
-        If StaticNAT is enabled, irrespective of the status of the 
-        conserve mode, no port forwarding or load balancing rule can be 
-        created for the IP. However, you can add the firewall rules by 
+      .. note::
+        If StaticNAT is enabled, irrespective of the status of the
+        conserve mode, no port forwarding or load balancing rule can be
+        created for the IP. However, you can add the firewall rules by
         using the createFirewallRule command.
 
    -  **Tags**: Network tag to specify which physical network to use.
@@ -428,21 +428,21 @@ To create a network offering:
       guest network, rules are added to allow the specified traffic.
 
    -  **Public**: Indicate whether the network offering should be available to
-      all domains or only some domains. Choose Yes to make it available to 
+      all domains or only some domains. Choose Yes to make it available to
       all domains. Choose No to limit the scope to one or more domains.
 
    -  **Domain**: This is only visible When ‘Public’ is unchecked. When visible,
-      this controls the domains which will be able to use this network offering. 
-      A multi-selection list box will be displayed. One or more domains can be 
-      selected from this list box by holding down the control key and selecting 
+      this controls the domains which will be able to use this network offering.
+      A multi-selection list box will be displayed. One or more domains can be
+      selected from this list box by holding down the control key and selecting
       the desired domains.
 
-   -  **Zone**: This controls which zones a network offering is available in. 
-      ‘All zones’ or only specific zones can be selected. One or more zones can be 
-      selected from this list box by holding down the control key and selecting 
+   -  **Zone**: This controls which zones a network offering is available in.
+      ‘All zones’ or only specific zones can be selected. One or more zones can be
+      selected from this list box by holding down the control key and selecting
       the desired zones.
 
 #. Click Add.
 
-.. |L2-networks-gui.JPG| image:: /_static/images/L2-networks-gui.JPG
+.. |L2-networks-gui.png| image:: /_static/images/L2-networks-gui.png
    :alt: Creating L2 network from GUI

source/adminguide/networking/multiple_subnets_in_shared_network.rst

@@ -12,7 +12,7 @@
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
-   
+
 
 Multiple Subnets in Shared Network
 ----------------------------------
@@ -90,7 +90,11 @@ Adding Multiple Subnets to a Shared Network
    -  **Start IP/ End IP**: A range of IP addresses that are accessible
       from the Internet and will be allocated to guest VMs. Enter the
       first and last IP addresses that define a range that CloudStack
-      can assign to guest VMs .
+      can assign to guest VMs.
+
+   -  **VLAN/VNI**: the ID or VID of the VLAN. If not specified, will be
+      defaulted to the vlan of the network or if vlan of the network is
+      null - to Untagged
 
 #. Click OK.
 

source/adminguide/networking/remote_access_vpn.rst

@@ -33,7 +33,7 @@ The VPN user database is shared across all the VPNs created by the
 account owner. All VPN users get access to all VPNs created by the
 account owner.
 
-.. note:: 
+.. note::
    Make sure that not all traffic goes through the VPN. That is, the route
    installed by the VPN should be only for the guest network and not for
    all traffic.
@@ -85,7 +85,9 @@ To enable VPN for a particular network:
 
 #. Click one of the displayed IP address names.
 
-#. Click the Enable VPN button. |vpn-icon.png|
+#. Click the VPN Tab
+
+#. Click the Enable Remote Access VPN. |vpn-icon.png|
 
    The IPsec key is displayed in a popup window.
 

source/adminguide/networking/site_to_site_vpn.rst

@@ -26,7 +26,7 @@ The supported endpoints on the remote datacenters are:
 
 -  CloudStack virtual routers
 
-.. note:: 
+.. note::
    In addition to the specific Cisco and Juniper devices listed above, the
    expectation is that any Cisco or Juniper device running on the supported
    operating systems are able to establish VPN connections.
@@ -48,7 +48,7 @@ To set up a Site-to-Site VPN connection, perform the following:
 Creating and Updating a VPN Customer Gateway
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. note:: 
+.. note::
    A VPN customer gateway can be connected to only one VPN gateway at a time.
 
 To add a VPN Customer Gateway:
@@ -79,7 +79,7 @@ To add a VPN Customer Gateway:
       authenticate the customer gateway and the VPC VPN gateway to each
       other. The sequence cannot contain a newline or double-quote.
 
-      .. note:: 
+      .. note::
          The IKE peers (VPN end points) authenticate each other by
          computing and sending a keyed hash of data that includes the
          Preshared key. If the receiving peer is able to create the same
@@ -92,7 +92,7 @@ To add a VPN Customer Gateway:
       AES256, and 3DES. Authentication is accomplished through the
       Preshared Keys.
 
-      .. note:: 
+      .. note::
          The phase-1 is the first phase in the IKE process. In this initial
          negotiation phase, the two VPN endpoints agree on the methods to
          be used to provide security for the underlying IP traffic. The
@@ -112,7 +112,7 @@ To add a VPN Customer Gateway:
       within phase-2. The supported encryption algorithms are AES128,
       AES192, AES256, and 3DES.
 
-      .. note:: 
+      .. note::
          The phase-2 is the second phase in the IKE process. The purpose of
          IKE phase-2 is to negotiate IPSec security associations (SA) to
          set up the IPSec tunnel. In phase-2, new keying material is
@@ -132,7 +132,7 @@ To add a VPN Customer Gateway:
       of the key exchanges increase as the DH groups grow larger, as
       does the time of the exchanges.
 
-      .. note:: 
+      .. note::
          When PFS is turned on, for every negotiation of a new phase-2 SA
          the two gateways must generate a new set of phase-1 keys. This
          adds an extra layer of protection that PFS adds, which ensures if
@@ -154,6 +154,9 @@ To add a VPN Customer Gateway:
       regular intervals. It's recommended to have the same configuration
       of DPD on both side of VPN connection.
 
+   -  **Force UDP Encapsulation of ESP Packets**: Force Encapsulation for
+      NAT traversal
+
 #. Click OK.