WebEx Server¶
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.
WebEx Field Reference¶
Title |
Field Type |
Description |
|---|---|---|
Type* |
type |
The type of WebEx server. It can be Cloud-Based. |
Protocol* |
protocol |
The protocol that is used for 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. |
Site Id |
site_id |
An Id for the site being managed, typically received from the Cisco WebEx Site Provisioning group. This field is mandatory if Site Name is not specified. |
Partner Id |
partner_id |
Partner ID typically received from the Cisco WebEx Site Provisioning group. |
Partner Credentials |
partner_ credentials_ override |
Partner credentials to use for this set of connection parameters. |
REST URI* |
rest_uri |
The relative URI of the XML service of the WebEx server. For example, WBXService/XMLService |
WebEx |
webex_id |
The WebEx Id of an administrator of the site. This is used to connect to to the server for administrative tasks such as adding or deleting users. |
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’. |
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.
Configure Cisco WebEx¶
This procedure adds and configures the server.
Note
For more information about conferencing, see Conferencing: Overview.
Log in as provider or reseller administrator.
Choose Device Management > WebEx > Servers.
Click Add.
Complete, at minimum, the mandatory WebEx Server Fields.
Click Save.
Test the connection to the WebEx server:
Select Device Management > Advanced > WebEx Network Device.
Click the WebEx server; then, choose Action > Test Connection.
WebEx Server Fields¶
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. |
Address * |
The IP address or hostname of the WebEx server. 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. |
Site Id |
An ID for the site being managed. Typically 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. |
REST URI * |
The relative URI for the XML service on the 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 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. |