Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

VMware VCloud Director

 

You can use the VMware vCloud Director DSM and the vCloud protocol for JSA to poll the vCloud REST API for events.

JSA supports polling for VMware vCloud Director events from vCloud Directory 5.1 appliances. Events that are collected by using the vCloud REST API are assembled as Log Extended Event Format (LEEF) events.

To integrate vCloud events with JSA, you must complete the following tasks:

  1. On your vCloud appliance, configure a public address for the vCloud REST API.

  2. On your JSA appliance, configure a log source to poll for vCloud events.

  3. Ensure that no firewall rules block communication between your vCloud appliance and the JSA console or the managed host that is responsible for polling the vCloud REST API.

Configuring the VCloud REST API Public Address

JSA collects security data from the vCloud API by polling the REST API of the vCloud appliance for events. Before JSA can collect any data, you must configure the public REST API base URL.

  1. Log in to your vCloud appliance as an administrator.
  2. Click the Administration tab.
  3. From the Administration menu, select System Settings >Public Addresses.
  4. In the VCD public REST API base URL field, type an IP address or host name.

    The address that you specify becomes a publically available address outside of the firewall or NAT on your vCloud appliance. For example, https://1.1.1.1/.

  5. Click Apply.

    The public API URL is created on the vCloud appliance.

You can now configure a log source in JSA.

Supported VMware vCloud Director Event Types Logged by JSA

The VMware vCloud Director DSM for JSA can collect events from several categories.

Each event category contains low-level events that describe the action that is taken within the event category. For example, user events can have user created or user deleted as a low-level event.

The following list is the default event categories that are collected by JSA from vCloud Director:

  • User events

  • Group events

  • User role events

  • Session events

  • Organization events

  • Network events

  • Catalog events

  • Virtual data center (VDC) events

  • Virtual application (vApp) events

  • Virtual machine (VM) events

  • Media events

  • Task operation events

Configuring a VMware VCloud Director Log Source in JSA

To collect VMware vCloud Director events, you must configure a log source in JSA with the location and credentials that are required to poll the vCloud API.

  1. Log in to JSA.
  2. Click the Admin tab.
  3. In the navigation menu, click Data Sources.
  4. Click the Log Sources icon.
  5. Click Add.
  6. In the Log Source Name field, type a name for your log source.
  7. In the Log Source Description field, type a description for your log source.
  8. From the Log Source Type list, select VMware vCloud Director.
  9. From the Protocol Configuration list, select VMware vCloud Director.
  10. Configure the following values:

    Table 1: VMware VCloud Director Log Source Parameters

    Parameter

    Description

    Log Source Identifier

    Type the IP address, host name, or name that identifies the vCloud appliance events to JSA.

    vCloud URL

    Type the URL configured on your vCloud appliance to access the REST API.

    The URL you type must match the address that you configured in the VCD public REST API base URL field on your vCloud Server.

    For example, https://10.10.10.1.

    User Name

    Type the user name that is required to remotely access the vCloud Server.

    For example, console/user@organization.

    If you want to configure a read-only account to use with JSA, you can create a vCloud user in your organization who has the Console Access Only permission.

    Password

    Type the password that is required to remotely access the vCloud Server.

    Confirm Password

    Confirm the password that is required to remotely access the vCloud Server.

    Polling Interval

    Type a polling interval, which is the amount of time between queries to the vCloud Server for new events.

    The default polling interval is 10 seconds.

    Enabled

    Select this check box to enable the log source. By default, the check box is selected.

    Credibility

    From the list, select the credibility of the log source. The range is 0 - 10.

    The credibility indicates the integrity of an event or offense as determined by the credibility rating from the source devices. Credibility increases if multiple sources report the same event. The default is 5.

    Target Event Collector

    From the list, select the Target Event Collector to use as the target for the log source.

    Coalescing Events

    Select this check box to enable the log source to coalesce (bundle) events.

    By default, automatically discovered log sources inherit the value of the Coalescing Events list from the System Settings in JSA. When you create a log source or edit an existing configuration, you can override the default value by configuring this option for each log source.

    Incoming Event Payload

    From the list, select the incoming payload encoder for parsing and storing the logs.

    Store Event Payload

    Select this check box to enable the log source to store event payload information.

    By default, automatically discovered log sources inherit the value of the Store Event Payload list from the System Settings in JSA. When you create a log source or edit an existing configuration, you can override the default value by configuring this option for each log source.

  11. Click Save.
  12. On the Admin tab, click Deploy Changes.

    vCloud events that are forwarded to JSA are displayed on the Log Activity tab of JSA.