Working With cfxEdgeCollector
Working with cfxEdgeCollector
Logging into cfxEdgeCollector User Interface (UI)
Open a browser and navigate to cfxEdgeCollector URL (https://<ipaddress>:8888)
Enter username and password as shown below.
The default username is cfxcollector
The default password is <Please contact CloudFabrix support>
Change default password using the following command from shell / CLI option
>>> cfxedgecollector configure --update password <new-password>
A sample login screen as shown below.
Click on the Sign-in button (as shown in the above screen capture) and the user will be logged into cfxEdgeCollector home page.
UI Logging using TACACS
Enter the following command to configure logging using Tacacs.
How to change authconfig for adding/modifying users
For changing authconfig, UI container should be in stopped state.
Adding Tacacs User:
Finding AuthConfig Status
To find the authconfig status, run the following command
How to create new cfxEdgeCollector job
Job: A logical definition or entity in cfxEdgeCollector context that captures all the necessary details like IP Address, MAC address, etc, to run cfxEdgeCollector to collect inventory data from a network.
From the home screen, click on 'Create New Job' from the home screen as shown below.
2. The default value will be normal for the collection profile. Users can change this based on the user's request.
3. Enter the job name and click on the 'Seeds and Restrictions' tab.
4. Enter the IP address or IP addresses range under the 'Seed Addresses' text field provided in the UI. For example, 10.95.158.1 - 10.95.158.24, 10.95.159.*/24
The seed address is used to discover all the network devices in a multi-hop fabric network.
5. Enter the IP address /address range which needs to be excluded from the discovery and inventory data collection under 'Exclude addresses'. This helps users to exclude IP addresses which are not needed to be part of discovery operation within the user's network.
6. Enter the IP address/addresses range under the 'Contain-To' address field to limit the device discovery and inventory data collection to specified IP address/addresses range.
7. Enter maximum discovery hops or leave the default value.
8. Click on the 'Credentials' tab to select and enter the required credentials details for discovery operation using various protocols.
9. Select Credential Type to select the type of credentials for example SNMP, SSH, or other protocols.
10. Below screen capture provides an example of defining SSH credentials for executing CLI commands. IP address field is used to apply the credentials during discovery and inventory data collection.
11. Click on 'Tags' tab and click on Add to assign tag names based on network.
12. Click on 'Features' tab and select the options as shown.
Features tab allow users to pick and choose what features are needed during the discovery.
13. Click on 'Save' to save the job.
How to run cfxEdgeCollector job?
Navigate to cfxEdgeCollector command line folder/home directory where cfxedgecollector is installed using terminal(shell) console.
Execute cfxedgecollector collect command with necessary parameters to start the collection (discovery and collection of data as per job configured via UI).
The following section provides an example:
cfxedgecollector collect --help provides syntax and supported CLI options.
How to export the collected inventory data
Run below command to export the collected data locally.
The above command creates a zip file of the collected inventory data of all devices and will be saved under ~/cfxedgecollector-1.0.27/exported-data folder/directory.
Note: This inventory data can be later uploaded to back-end applications (cfxAIA).
Last updated