Working With cfxEdgeCollector

Working with cfxEdgeCollector

Logging into cfxEdgeCollector User Interface (UI)

  1. Open a browser and navigate to cfxEdgeCollector URL (https://<ipaddress>:8888)

  2. 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

  1. Enter the following command to configure logging using Tacacs.

>>> cfxedgecollector authconfig --help
usage: cfxedgecollector authconfig [-h] [--authprovider {basic,tacacs}]
                                   [--host HOST] [--port PORT]
                                   [--secret SECRET] [--status]
                                   [--timeout TIMEOUT] [--users USERS]
                                   [--useradd USERADD]
                                   [--userdelete USERDELETE]

optional arguments:
  -h, --help            show this help message and exit
  --authprovider {basic,tacacs}
                        Type of the authentication provider
  --host HOST           auth server location
  --port PORT           auth server port
  --secret SECRET       secret for auth server
  --status              Show authentication status
  --timeout TIMEOUT     Authentication timeout
  --users USERS         Users who can access the edgecollector
  --useradd USERADD     Add an user to the allowed user list
  --userdelete USERDELETE Remove an user from the allowed user list

How to change authconfig for adding/modifying users

For changing authconfig, UI container should be in stopped state.

Adding Tacacs User:

>>> cfxedgecollector  authconfig  --authprovider tacacs --host <host IP or FQDN> --port <port number> 
                                  --secret <user> --timeout 15 --users <user>

Finding AuthConfig Status

To find the authconfig status, run the following command

[For Basic]
>>> cfxedgecollector authconfig --status 

       Authentication provider: basic
[For Tacacs]
>>> cfxedgecollector authconfig --status
Example Output:
      Authentication provider: tacacs
      Port: 49
      Users: hari

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.

  1. 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.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?

  1. Navigate to cfxEdgeCollector command line folder/home directory where cfxedgecollector is installed using terminal(shell) console.

  2. Execute cfxedgecollector collect command with necessary parameters to start the collection (discovery and collection of data as per job configured via UI).

>>> cfxedgecollector collect <jobname>

The following section provides an example:

>>> cfxedgecollector collect new
Picked load profile 'normal' from 'system' directory
Starting edge collection with load profile normal.[ memory minimum 2000m with 100 workers ]

cfxedgecollector job is running in the background with Id: 549c33d4c043

License is a Trial License
License Granted To: EdgeCollector Trial License with Expiration Date: 01/30/2021


Starting Discovery Engine...
old logs archived at /collector-data/new/logs/
Total provided seed addresses: 1
Log/Data location:  /collector-data
|      IP Address |  Protocol |             Port Status |          Used credential |    Auth status|                                           Comment|
Seeding hosts information..
Starting discovery worker threads...
| |      ICMP |        (Not Applicable) |                          | Success       |                                                                |
| |   snmpv2c |     161(Not Applicable) |                     snmp | Success       | Cisco IOS Software, C3560E Software (C3560E-UNIVERSALK9-M), Ver|
Collection status....
Total/Completed/Pending 1/0/1 ; Success/Failed/Duplicates 0/0/0
| |     SSHV2 |      22(Success       ) |                      ssh | Success       |                 15.2(3)E:CFX-MainSwitch:FDO1709Z29Q:FDO1709Z29Q|
Total/Completed/Pending 1/0/1 ; Success/Failed/Duplicates 0/0/0
Total/Completed/Pending 1/0/1 ; Success/Failed/Duplicates 0/0/0
Total/Completed/Pending 1/1/0 ; Success/Failed/Duplicates 1/0/0
Discovery and Connector Execution is finished.
Gracefully shutting down Host Seeder Threads
Gracefully shutting down SNMP Worker Threads
Gracefully shutting down Connector Worker Threads
Gracefully shutting down DNS Resolver Threads
Collection completed (Duration: 76 secs)
Overall Job Summary:

Seeded: 1, In Progress: 0, Success: 0, Partial Success: 1, Failed: 0, Duplicate: 0

cfxedgecollector collect --help provides syntax and supported CLI options.

How to export the collected inventory data

  1. Run below command to export the collected data locally.

>>>cfxedgecollector export --jobname <job-name> --localonly

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