.. _webex_field_reference:

WebEx 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'.                |
+-------------+---------------+---------------------------------------+