diff --git a/VMware NSX-T/README.md b/VMware NSX-T/README.md index 46ff6f77..0f41ffac 100644 --- a/VMware NSX-T/README.md +++ b/VMware NSX-T/README.md @@ -1,12 +1,15 @@ # Forescout + eyeExtend Connect for VMware NSX-T App README.md Version: 1.0.0 ## Configuration Guide -**Version 1.0.0** -- Initial app providing basic host discovery via visibility of Logical Switch and Router ARP entries from VMware NSX-T +### Version 1.0.0 + +- Initial app providing basic host discovery via visibility of Logical Switch and Router ARP entries from VMware NSX-T ## Contact Information + - Have feedback or questions? Write to us at **[connect-app-help@forescout.com](mailto:connect-app-help@forescout.com)** @@ -14,26 +17,33 @@ eyeExtend Connect for VMware NSX-T App README.md Version: 1.0.0 ## App Support - All eyeExtend Connect Apps posted here are community contributed and community supported. These Apps are not supported by the Forescout Customer Support team. + - See Contact Information above. ## About eyeExtend Connect App for VMware NSX-T -# About This App +### About This App The VMware NSX-T app provides discovery of devices, via visibility of ARP entries, as reported by Logical Switches and Logical Routers within a VMware NSX-T environment. - Tested with VMware NSX-T 3.1.x + - HTTP Basic Authentication Only + - Session-Based and X.509 authentication is not currently supported -- NSX-T Manager in VMware Cloud on AWS (VMC) is not currently supported -# What to Do + - NSX-T Manager in VMware Cloud on AWS (VMC) is not currently supported + +### What to Do + Define a Username and Password on the NSX-T Manager(s) that are to be integrated with. Ensure that these credentials have sufficent permissions to use the NSX-T Data Center REST API -# How to Install +### How to Install + Get Forescout eyeExtend Connect plugin and VMware NSX-T App from Forescout. -## Ensure That the Plugin is Running +### Ensure That the Plugin is Running + After installing the Connect plugin, ensure that it is running. To verify: @@ -41,39 +51,43 @@ To verify: 1. Select **Tools** > **Options** > **Modules**. 2. Navigate to the component and hover over the name to view a tooltip indicating if it is running on Forescout devices in your deployment. In addition, next to the component name, you will see one of the following icons: -- The component is stopped on all Forescout devices. -- The component is stopped on some Forescout devices. -- The component is running on all Forescout devices. + - The component is stopped on all Forescout devices. + + - The component is stopped on some Forescout devices. + + - The component is running on all Forescout devices. 3. If the component is not running, select **Start** , and then select the relevant Forescout devices. + 4. Select **OK**. -# Configure the Module +## Configure the Module + After eyeExtend Connect is installed, **Connect** is displayed under **Options**. -## Configure VMware NSX-T App +### Configure VMware NSX-T App + To configure eyeExtend Connect for VMware NSX-T, you import the VMware NSX-T App. Initially, the App Configuration tab of the **Connect** pane is blank. The VMware NSX-T App has not been imported yet. -## Import an App +### Import an App + You can import the VMware NSX-T App. To import the VMware NSX-T App: -In the App Configuration tab of the **Connect** pane, select **Import**. +- In the App Configuration tab of the **Connect** pane, select **Import**. Apps that can be imported are in .zip or .eca format. They can be in any folder. - Select **Import**. + +- Select **Import**. If the app is imported successfully, a message is displayed at the bottom of the **Sending** dialog box. If the app is not imported successfully, error messages are displayed in the **Sending** dialog box. -Select -**Close** when the import has finished. -A blank **System Description** dialog box opens. +- Select **Close** when the import has finished. A blank **System Description** dialog box opens. - If you select **Close** before the import has finished, it will fail. -## Panels - +### Panels After the app is imported, the **System Description** dialog box opens. It is initially blank and only the **Add** and **Import** buttons are enabled. @@ -85,44 +99,47 @@ Select **Add** ### VMware NSX-T Connection - Enter the following information: - Manager Address: Enter the VMware NSX-T manager IP address, FQDN or Hostname. -- Server Port: Enter the VMware NSX-T manager port. The default is TCP/443 + +- Server Port: Enter the VMware NSX-T manager port. The default is TCP/443 + - Username: Enter the username for accessing VMware NSX-T + - Password: Enter and verify the password for accessing VMware NSX-T -Select **Next** +Select **Next** ### Focal Appliance - - - Initially, the Assign Forescout Focal Appliance panel has only one option, **Assign all devices by default** , and it is selected so that one device is added. +- Initially, the Assign Forescout Focal Appliance panel has only one option, **Assign all devices by default** , and it is selected so that one device is added. If you want to add a second device, the Assign Forescout Focal Appliance panel has more options. Enter the following information: - Connecting CounterACT Device: Select Enterprise Manager or an IP address of the connecting Forescout Focal Appliance. In an environment where more than one Forescout Appliance is assigned to a single third-party instance, the connecting Forescout Focal Appliance functions as a middleman between the third-party instance and the Forescout Appliances. The connecting Forescout Focal Appliance forwards all queries and requests to and from the third-party instance. + - Assign specific devices: This Forescout Appliance is assigned to a third-party instance, but it does not communicate with it directly. All communication between the third-party instance and its assigned Forescout Appliance is handled by the connecting Forescout Focal Appliance defined for the third-party instance. All the IP addresses handled by an assigned Appliance must also be handled by the third-party instance to which the Appliance is assigned. + - Select **Available Devices** and then select an IP address or Appliance name from the Available Devices list. + - Select **Add**. The selected device will send its requests to the third-party instance through the connecting Appliance. -- Assign all devices by default: This is the connecting Appliance to which Forescout Appliances are assigned by default if they are not explicitly assigned to another connecting Appliance. Select this option to make this connecting Appliance the middleman for all Forescout Appliances not assigned to another connecting device. +- Assign all devices by default: This is the connecting Appliance to which Forescout Appliances are assigned by default if they are not explicitly assigned to another connecting Appliance. Select this option to make this connecting Appliance the middleman for all Forescout Appliances not assigned to another connecting device. Note the following: - An error message is displayed if you try to add a device that is already used. -- If you have apps that discover 50,000 or more endpoints, distribute the apps in such a way so that only up to two of the apps share the same focal (connecting) appliance. An alternative is to split the endpoints across multiple user accounts on multiple servers. +- If you have apps that discover 50,000 or more endpoints, distribute the apps in such a way so that only up to two of the apps share the same focal (connecting) appliance. An alternative is to split the endpoints across multiple user accounts on multiple servers. Select **Next**. ### Proxy Server - Enter the Proxy Server information similar to any Forescout eyeExtend Module Select **Next**. @@ -136,6 +153,7 @@ Select **Next**. - Number of API queries per second: Select a value for the rate limiter. The default is 100 request per second. You can rate limit the requests sent to the third-party server. The rate limiter specifies the number of times a script is invoked during the specified time. It is triggered when the app starts. ## Edit a System Description + You can edit an existing system description for the VMware NSX-T App. To edit a system description: @@ -147,6 +165,7 @@ There are tabs for each pane. You can edit the settings in the VMware NSX-T Conn Select **OK** to save the system description edits to the Forescout Appliance. ## Remove a System Description + You can remove an existing system description. To remove a system description: @@ -156,6 +175,7 @@ Select **Remove**. A confirmation is displayed. **More** for details or **Ok**. ## Test a System Description + You can test a system description, which tests the connection of the VMware NSX-T App to the VMware NSX-T Manager. The app must be in the Running state. Also, the app must be saved before selecting **Test**. Select **OK** in the **System Description** dialog box and then select **Apply** in the **Connect** pane to save the system description. Please wait about 5-10 seconds after clicking apply. @@ -167,4 +187,4 @@ Select **Test**. If the connectivity of the system description has been tested successfully, a success message is displayed at the top of the dialog box. If the test failed, a failure message is displayed with a reason. -**Close**. \ No newline at end of file +**Close**.