.. _webex-server:



Webex Servers
-----------------

Overview 
.........

Webex 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.



.. _device_model_mapping:

Device Model Mapping
.....................

A data model is maintained in VOSS Automate where its instances map network device
types to data models. For example, the network device device/cucm would have a
mapping to data/CallManager. These target data models are used to maintain network
device data in VOSS Automate, and any of their default connection parameters.


.. _set_up_cisco_webex:


Add a Cisco Webex server
...........................

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. Go to (default menus) **Apps 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 **Apps Management > Advanced > WebEx Network Device**. 
   * Click in the row for the relevant Webex server; then, choose **Action > Test Connection**.


.. _webex_server_fields:

Webex Server Field Reference
..............................

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

+-----------------+-------------------------------------------------+
| Field           | Description                                     |
+=================+=================================================+
| Type            | Mandatory. The type of Webex server. Read-only. |
|                 | Set to Cloud-Based.                             |
+-----------------+-------------------------------------------------+
| Protocol        | Mandatory. Protocol used for communication with |
|                 | the Webex server, either https or http. Default |
|                 | https.                                          |
+-----------------+-------------------------------------------------+
|                 | Mandatory. The IP address or hostname of the    |
| Address         | Webex server, for example, Site-name.webex.com  |
+-----------------+-------------------------------------------------+
| Port            | The port used to communicate with the Webex     |
|                 | Server. Defaults to 443.                        |
+-----------------+-------------------------------------------------+
| Site Name       | Mandatory if Site ID is not specified. The name |
|                 | of the site to be managed. Usually              |
|                 | matches the start of the Webex address.         |
+-----------------+-------------------------------------------------+
|                 | Mandatory if Site Name is not specified. The ID |
|                 | of the site being managed. Typically            |
| Site Id         | received from Cisco Webex Site Provisioning     |
|                 | group. Provide this field value before testing  |
|                 | the connection to the Webex server.             |
+-----------------+-------------------------------------------------+
|                 | Mandatory. Defaults to WBXService/XMLService.   |
|                 | The relative URI for the XML service on the     |
| REST URI        | Webex server.                                   |
+-----------------+-------------------------------------------------+
| WebEx Id        | Either the Webex ID or the Email field is       |
|                 | mandatory. The Webex administrator ID, used to  |
|                 | connect to the server for admin tasks, such as  |
|                 | adding or deleting users.                       |
+-----------------+-------------------------------------------------+
| Email           | Either the Webex ID or the Email field is       |
|                 | mandatory. Required if no Webex ID is provided. |
|                 | A valid email address for the administrator.    |
+-----------------+-------------------------------------------------+
| Password        | Mandatory. The password for the administrator   |
|                 | with the supplied Webex ID.                     |
+-----------------+-------------------------------------------------+
| Version         | Supported Webex server versions. Supported      |
|                 | server versions can be either 27.00 or 29.13.   |
+-----------------+-------------------------------------------------+