3.4. Using facts-finder - CleanFacts - add custom config

  1. Generate clean config using CleanFacts

  2. Apply custom chages on database

  3. rearrange database columns of Excel

3.4.1. Detailed How To

Once CleanFacts are generated ( Point. 3 from previous page ), go ahead with below steps.

  1. Import necessary custom package, modules

    modify as per custom package/module name(s).

    customer_x: is custom package

    package_class: custom package class containing modifying methonds.

    from customer_x import CustomDeviceFacts

  2. Provide Input to Custom Class

    Provide the generated CleanFact instance object to custom package class.

    Evaluate/Modify using custom method.

    ADF = CustomDeviceFacts(cf)                     ## provide input to custom class
ADF()                                                           ## call to generate modified data.
ADF.write()                                                     ## custom method to write out modified data.

  3. Rearrange columns in excel file in orders [optional step]

    Orders are defined as per rearrange.py module of the package.

    rearrange_tables(cf.clean_file, foreign_keys=FOREIGN_KEYS)  ## refer below for foreign_keys parameter

Note

Information

FOREIGN_KEYS should be a dictionary of lists for addtional custom columns.

Its keys should be from these (‘bgp’, ‘vrf’, ‘interfaces’)

Example: FOREIGN_KEYS={

‘bgp’: [‘custom_col_bgp_para’, ], ‘vrf’: [‘custom_col_vrf_para1’, ‘custom_col_vrf_para2’], ‘interfaces’: [‘custom_col_int_para’, ], }

Notice

Make a note that output differs between version to version on devices, and thus it is obvious that parsing may not work every where, as expected incase if format differs from expectation.

Make sure to cross-check the generated facts before using it.