[Index]

Model: relation/HcsWebExREL

WebEx Network Device

Full HTML Help

Overview

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

The support for Cisco Webex is as follows:

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

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.

Add a Cisco Webex server

This procedure adds and configures the server.

Note

For more information about conferencing, see 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 WebEx Server Fields.
  5. Click Save.
  6. Test the connection to the Webex server:

Webex Server Field Reference

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.
Address Mandatory. The IP address or hostname of the 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.
Site Id Mandatory if Site Name is not specified. The ID of the site being managed. Typically received from Cisco Webex Site Provisioning group. Provide this field value before testing the connection to the Webex server.
REST URI Mandatory. Defaults to WBXService/XMLService. The relative URI for the XML service on the 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.

Servers

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

For additional information about conferencing, see Conferencing.

Procedure

  1. Log in as provider or reseller administrator.
  2. Choose Device Management > WebEx > Servers.
  3. Click Add.
  4. Complete, at minimum, the mandatory WebEx Server Fields.
  5. Click Save.

What to Do Next

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

Model Details: relation/HcsWebExREL

Title Description Details
Type * The type of WebEx server. Can be 'Cloud-Based'.
  • Field Name: type
  • Type: String
  • Choices: ["Cloud-Based"]
Protocol * The protocol that is used for communication with the WebEx server.
  • Field Name: protocol
  • Type: String
  • Choices: ["https", "http"]
Address * The address of the WebEx server eg. site-name.webex.com.
  • Field Name: address
  • Type: String
Port The port that is used for communication with the WebEx server.
  • Field Name: port
  • Type: String
Site Name The name of the site to be managed which is typically the same as the WebEx address prefix. This field is mandatory if Site ID is not specified.
  • Field Name: site_name
  • Type: String
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.
  • Field Name: site_id
  • Type: String
Partner Id Partner ID, typically received from the Cisco WebEx Site Provisioning group.
  • Field Name: partner_id
  • Type: String
Partner Credentials Partner credentials to use for this set of connection parameters
  • Field Name: partner_credentials_override
  • Type: String
  • Target: data/WebExPartnerCredentials
  • Target attr: name
  • Format: uri
REST URI * The relative URI of the XML service of the WebEx server eg. WBXService/XMLService
  • Field Name: rest_uri
  • Type: String
WebEx Id The WebEx Id of an administrator of the site. This used to connect to the server for administrative tasks such as adding/deleting users.
  • Field Name: webex_id
  • Type: String
Email A valid email for the administrator. Required if no WebEx Id is provided.
  • Field Name: email
  • Type: String
Password The password for the administrator with the supplied WebEx Id.
  • Field Name: password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Version * Supported WebEx server versions.
  • Field Name: version
  • Type: String
  • Choices: ["27.00", "29.13"]
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024