.. _zoom-server:

.. rst-class:: chapter-with-expand


Zoom Server
-----------------

Zoom is a web conferencing facility used for collaboration with
colleagues across your organization.

The support for Cisco WebEx is as follows:

* Hosted WebEx Cloud.
* Ability to create user accounts and meetings using WebEx versions:

  * 6.0 API and 27.00 server
  * 8.0 API and 29.13 server
* User and Meeting APIs are exposed and available, so that user
  capability can be managed. However, system setup, Site addition, and
  meeting functions, are done with the WebEx application.

Parameters are defined when adding WebEx instances of Network Devices on the Admin Portal.





.. _zoom_field_reference:

Zoom Field Reference
......................



.. tabularcolumns:: |p{3cm}|p{3cm}|p{8cm}|

+-------------+---------------+---------------------------------------+
| Title       | Field Type    |             Description               |
+=============+===============+=======================================+
| Type\*      | type          | The type of WebEx server. It can be   |
|             |               | **Cloud-Based**.                      |
+-------------+---------------+---------------------------------------+
|             |               | The protocol that is used for         |
| Protocol\*  | protocol      | communication with the WebEx server   |
|             |               | The protocol can either be 'https' or |
|             |               | 'http'.                               |
+-------------+---------------+---------------------------------------+
| Address\*   | address       | The address of the WebEx server. For  |
|             |               | example, Site-name.webex.com.         |
+-------------+---------------+---------------------------------------+
| Port        | port          | The port that is used for             |
|             |               | communication with the WebEx server.  |
+-------------+---------------+---------------------------------------+
| Site Name   | site_name     | The name of the site to be managed.   |
|             |               | This name is typically the same as    |
|             |               | the start of the WebEx address. This  |
|             |               | field is mandatory if Site ID is not  |
|             |               | specified.                            |
+-------------+---------------+---------------------------------------+
|             |               | An Id for the site being managed,     |
|             |               | typically received from the Cisco     |
| Site Id     | site_id       | WebEx Site Provisioning group. This   |
|             |               | field is mandatory if Site Name is    |
|             |               | not specified.                        |
+-------------+---------------+---------------------------------------+
|             |               | Partner ID typically received from    |
| Partner Id  | partner_id    | the Cisco WebEx Site Provisioning     |
|             |               | group.                                |
+-------------+---------------+---------------------------------------+
| Partner     | partner\_     | Partner credentials to use for this   |
| Credentials | credentials\_ | set of connection parameters.         |
|             | override      |                                       |
+-------------+---------------+---------------------------------------+
|             |               | The relative URI of the XML service   |
| REST URI\*  | rest_uri      | of the WebEx server. For example,     |
|             |               | WBXService/XMLService                 |
+-------------+---------------+---------------------------------------+
|             |               | The WebEx Id of an administrator of   |
|             |               | the site. This is used to connect to  |
| WebEx       | webex_id      | to the server for administrative      |
|             |               | tasks such as adding or deleting      |
|             |               | users.                                |
+-------------+---------------+---------------------------------------+
| Email       | email         | A valid email for the administrator.  |
|             |               | Required if no WebEx Id is provided.  |
+-------------+---------------+---------------------------------------+
| Password\*  | password      | The password for the administrator    |
|             |               | with the supplied WebEx Id.           |
+-------------+---------------+---------------------------------------+
| Version     | version       | Supported WebEx server versions. The  |
|             |               | supported server versions can either  |
|             |               | be '27.00' or '29.13'.                |
+-------------+---------------+---------------------------------------+




.. _set_up_zoom:



Configure Zoom
..................

This procedure adds and configures the server. 

.. note:: 
   
   For more information about conferencing, see :ref:`conferencing`.


1. Log in as provider or reseller administrator.
2. Choose **Device Management > WebEx > Servers**.
3. Click **Add**.
4. Complete, at minimum, the mandatory :ref:`webex_server_fields`.
5. Click **Save**.
6. Test the connection to the WebEx server:
   
   * Select **Device Management > Advanced > WebEx Network Device**. 
   * Click the WebEx server; then, select **Action > Test Connection**.


.. _zoom_server_fields:

Zoom Server Fields
...................

.. tabularcolumns:: |p{3.5cm}|p{12cm}|

+-----------------+-------------------------------------------------+
| Field           | Description                                     |
+=================+=================================================+
| Type \*         | WebEx server type. Read-only field set to       |
|                 | Cloud-Based.                                    |
+-----------------+-------------------------------------------------+
| Protocol \*     | Protocol used to communicate with WebEx server. |
|                 | This field is mandatory and defaults to https.  |
+-----------------+-------------------------------------------------+
|                 | The IP address or hostname of the WebEx server. |
| Address \*      | This field is mandatory. Example:               |
|                 | site-name.webex.com                             |
+-----------------+-------------------------------------------------+
| Port            | The port used to communicate with the WebEx     |
|                 | Server. Defaults to 443.                        |
+-----------------+-------------------------------------------------+
| Site Name       | The name of the site to be managed. Usually     |
|                 | matches the start of the WebEx address.         |
+-----------------+-------------------------------------------------+
|                 | An ID for the site being managed. Typically     |
| Site Id         | received from Cisco WebEx Site Provisioning     |
|                 | group. Provide this field before testing the    |
|                 | connection to the WebEx server.                 |
+-----------------+-------------------------------------------------+
| Partner Id      | Typically received from                         |
|                 | Cisco WebEx Site Provisioning group.            |
+-----------------+-------------------------------------------------+
|                 | The relative URI for the XML service on the     |
| REST URI \*     | WebEx server. This field is mandatory and       |
|                 | defaults to WBXService/XMLService.              |
+-----------------+-------------------------------------------------+
| WebEx Id        | WebEx administrator ID. Either the WebEx Id or  |
|                 | the Email field is mandatory.                   |
+-----------------+-------------------------------------------------+
| Email           | Email address of WebEx administrator. Either    |
|                 | the WebEx Id or the Email field is mandatory.   |
+-----------------+-------------------------------------------------+
| Password        | Password for the provided WebEx administrator.  |
|                 | This field is mandatory.                        |
+-----------------+-------------------------------------------------+
| Repeat Password | Confirm password for the provided WebEx         |
|                 | administrator. This field is mandatory.         |
+-----------------+-------------------------------------------------+
| Version \*      | Supported WebEx version.                        |
+-----------------+-------------------------------------------------+