splunk / ta-cisco-webex-meetings-add-on-for-splunk

Cisco WebEx Meetings Addon for Splunk 📦➜

Cisco WebEx Meetings Add-on for Splunk

The Cisco WebEx Meetings Add-on for Splunk uses the Webex Meetings XML API to fetch data and ingest it into Splunk.

Getting Started

This is a TA to pull in data from Cisco WebEx Meetings XML API. These API endpoints are being hit to fetch data for the meetings.

XML API	Sourcetype	Splunk Time Field	Type	Recommended Interval
LsttrainingattendeeHistory	cisco:webex:meetings:history:trainingattendeehistory	startTime	Historical	>= 86400
LstsupportattendeeHistory	cisco:webex:meetings:history:supportattendeehistory	startTime	Historical	>= 86400
LsteventattendeeHistory	cisco:webex:meetings:history:eventattendeehistory	startTime	Historical	>= 86400
LstmeetingattendeeHistory	cisco:webex:meetings:history:meetingattendeehistory	joinTime	Historical	>= 86400
LstmeetingusageHistory	cisco:webex:meetings:history:meetingusagehistory	meetingStartTime	Historical	>= 86400
LsteventsessionHistory	cisco:webex:meetings:history:eventsessionhistory	sessionStartTime	Historical	>= 86400
LstrecordaccessHistory	cisco:webex:meetings:history:recordaccesshistory	creationTime	Historical	>= 86400
LstsupportsessionHistory	cisco:webex:meetings:history:supportsessionhistory	sessionStartTime	Historical	>= 86400
LsttrainingsessionHistory	cisco:webex:meetings:history:trainingsessionhistory	sessionStartTime	Historical	>= 86400
LstsummarySession	cisco:webex:meetings:general:summarysession	actualStartTime	Active Sessions	<= 60

DISCLAIMER: Guidance from Cisco states historical data retrieval may be incomplete if fetched less than 48 hours from time meetings ended. Therefore it's recommended to set the interval to 86400 or more for historical input.

Create a Service Account

Create the service account in Webex Meetings site's admin portal (CompanyXYZ.webex.com). Once the API user was created it was linked to the Control Hub because we have linked sites.

Based on which Cisco Webex Meetings you have, the account creation might be different.

If you have to go to admin.webex.com (Control Hub) to login and manage your webex account, you may run into some issues. Generally, Webex Teams and Webex Meetings portal are completely automated from Active directory connector and adding a local user is DISABLED as soon as AD connector is set up.

If you do not have any automation enabled, you should be able to create a user, you will have to assign a license to the user and then give the user partial Site Admin read-only rights.

If you are managing the site from Control Hub, please take a look at this link it should help.

Alternatively, Add-Users-Manually-in-Cisco-Webex-Control-Hub can also be a workaround if you have AD Connector setup as well.

Create a Webex Meetings OAuth Integration App

An integration is what you'd have to use if you have Single Sign-On (SSO) or OAuth enabled in your Webex account and you are not able to create a Service Account. This requires you to be logged in to Cisco DevNet using a Webex Meetings Site Admin account. The dialog prompt for logging in to DevNet has the option to Login with Webex Meetings. Please make sure you pick the Login with Webex Meetings option, and other log in options will not work for this purpose. After login you can create a dedicated integeration app for this Add-on.

• Log in to Cisco DevNet using a Webex Meetings Site Admin account.

• Click on Add App Information button on the top right corner.

• Enter the following details:

  • Integration name: Enter a integration name as you like.
  • Redirect URI: The Redirect URI MUST follow this pattern:

  https://{{domain}}/en-US/splunkd/__raw/services/cisco-webex-meetings-oauth

  Please replace the {{domain}} with the domain of your Splunk Heavy Forwarder (or IDM). For example, if the domain of your HF or IDM is example.splunk.link, the Redirect URI you have to enter is:

  https://example.splunk.link/en-US/splunkd/__raw/services/cisco-webex-meetings-oauth

  Note: If your Splunk site is not in en-US, please change it to your true value.

  • Scope: Please ONLY pick read_all. DO NOT pick any other options.
  • Description: Enter some details about what your integration does. This is optional.

• Click on Submit button.

• Please copy the Client ID and Client Secret somewhere for further use.

Installation and Configuration Steps

This application can be installed on-prem and cloud.

Installation Steps for on-prem

Install the TA on one of the Heavy Forwarder(s).

Installation Steps for cloud

Create a support ticket with APP-CERT reference to get it installed on the Cloud instance OR follow the cloud-ops steps to install non-published applications.

Configuration steps

The configuration steps are common for on-prem and cloud. Please follow the following steps in order:

1. Open the Web UI for the Heavy Forwarder (or IDM).
2. Access the TA from the list of applications.
3. Set global setings. If you use a Webex Service Account, please refer to Section 3.1 to set global settings. If you have Single Sign-On (SSO) or OAuth enabled in your Webex accout, please refer to Section 3.2 to set global settings.

   3.1 Set global settings for Webex Service Account

   Please refer to Create a Service Account section to create a Sevice Account first.
   • Click on Configuration button on the top left corner.
   • Click on Add-on Settings button.
   • Enter the following details:
     • Site Name (required): This identifies the Webex site you are targeting with your add-on. For example, if the URL is https://splunk.webex.com, the Webex Site that you have to enter is splunk.
     • Username (required): Service Account Username or E-mail address of the host or admin account making the request. For example: [e-mail].
     • Authentication Type (required): Please select Basic Password Auth for Webex Service Account.
     • Redirect URI (optional): Please leave it blank. (Redirect URI is optional for Basic Password Auth type.)
     • Client ID (optional): Please leave it blank. (Client ID is optional for Basic Password Auth type.)
     • Client Secret (optional): Please leave it blank. (Client Secret is optional for Basic Password Auth type.)
     • Password / Access Token (required): Password of the account associated with the e-mail address above. The password will be masked.
     • Refresh Token (optional): Please leave it blank. (Refresh Token is optional for Basic Password Auth type.)
   • Click on the Save green button.

   3.2 Set global settings for OAuth

   Please refer to Create a Webex Meetings OAuth Integration App section to create a integration app first.
   • Click on Configuration button on the top left corner.
   • Click on Add-on Settings button.
   • Enter the following details:
     • Site Name (required): This identifies the Webex site you are targeting with your add-on. For example, if the URL is https://splunk.webex.com, the Webex Site that you have to enter is splunk.
     • Username (required): Service Account Username or E-mail address of the host or admin account making the request. For example: [e-mail].
     • Authentication Type (required): Please select OAuth for SSO/OAuth enabled account.
     • Redirect URI (required): Please enter the Redirect URI of your Webex Meetings Integration App. It MUST match the Redirect URI that is defined in your Webex Meetings Integration configuration. For example, https://{{domain}}/en-US/splunkd/__raw/services/cisco-webex-meetings-oauth. (Redirect URI is required for OAuth type.)
     • Client ID (required): Please enter the Client ID of your Webex Meetings Integration App that you create for this Add-on. (Client ID is required for OAuth type.)
     • Client Secret (required): Please enter the Client Secret of your Webex Meetings Integration App that you create for this Add-on. (Client Secret is required for OAuth type.)
     • Password / Access Token (required): To get the Access Token, please click Generate Tokens button under the text box. (Note: Please make sure you enter the correct Client ID and Client Secret at the last steps.) In the pop-up window, enter your email/username, and hit Next. Click the Accept button to grant the permissions. You should see your Access Token and Refresh Token. Copy & paste the Access Token here. (Note: If you see the error messages, e.g. "Invalid client secret", please close the pop-up window, enter the correct client secret, and re-click the Generate Tokens to start over it again.)
     • Refresh Token (required): Copy & paste the Refresh Token that obtained from the last step here. (Refresh Token is required for OAuth type.)
   • Click on the Save green button.
4. Create input for active scheduled sessions .

• Click on Inputs button on the top left corner.
• Click on Create New Input button on the top right corner.
• Select General Service
• Enter the following details in the pop-up box:
  • Name (required): Unique name for the data input.
  • Interval (required): Time interval of input in seconds. Note: Interval should be 60 or less for general service session data.
  • Index (required): Index for storing data.
  • Monitor Active Session: Please make sure Monitor Active Session is checked.
• Click on the Add green button on the bottom right of the pop-up box.

5. Create input for historical meetings.

• Click on Inputs button on the top left corner.
• Click on Create New Input button on the top right corner.
• Select History Service
• Enter the following details in the pop-up box:
  • Name (required): Unique name for the data input.
  • Interval (required): Time interval of input in seconds. Note: Interval should be 86400 (24 hours) or more for historical data
  • Index (required): Index for storing data.
  • Endpoints (required): Historical endpoints that are used to fetch historical data back.
  • Begin Time (required): This is the time from where you want to ingest the historical data. Please enter UTC time. Format: MM/DD/YYYY hh:mm:ss NOTE: Begin Date must be at least 3 days ago and ideally no more than 90 days.
  • Paging Interval: Please enter an integer. This is used to slice the large time range. For example, if your Begin Time is set to be 2 months ago, and the two-month data volume is too large to be handled in the first ingestion. You can leverage the Paging Interval to slice the time range. If it is set to 1 day, it will ingest data day by day instead of ingesting the 2-month data at one time. The default value is 1 day. Format: Int.
  • Paging Interval Unit: Choose the unit of the paging interval.
• Click on the Add green button on the bottom right of the pop-up box.

6. Set Proxy Setting (optional)

• Click on Configuration button on the top left corner.
• Click on Proxy button.
• Enter the following details:
  • Enable (required) : Check Enable box if you want to enable proxy support
  • Proxy Type (required) : Select a Proxy Type: http, socks4, socks5.
  • Host (required) : Proxy URL.
  • Port (required) : Proxy Port.
  • Username : Proxy Username.
  • Password : Proxy Password.
  • Remote DNS resolution : Checkbox for enabling remote DNS resolution.
• Click on the Save green button.

Troubleshooting

• Check Conenctivity to WebEx API via shell/curl script.

Versions Supported

• Tested for installation and basic ingestion on 8.1.0, 8.0.1, 7.3, 7.2, and 7.0 based on Cisco WebEx Meetings test account.

Built by Splunk's FDSE Team.

Credits & Acknowledgements

• Yuan Ling
• Joe Welsh
• Ankit Bhagat
• Sandeep Vasani
• Steven Hanna
• Mayur Pipaliya

EOF 🏁

• Want to contribute? Great! Feel free to create a PR.

• Found a 🐛 bug? Open an issue with some emojis. Issues without emojis are not valid.