Model: relation/HcsWebExREL

Servers

For additional information about conferencing, see Conferencing.

Procedure

Log in as provider or reseller administrator.
Choose Device Management > WebEx > Servers.
Click Add.
Complete, at minimum, the mandatory WebEx Server Fields.
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

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

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