config

Reference Documentation

product_line_custom
Intel® PAC
Napatech SmartNIC
category
Reference Information
Napatech Software Suite: config
config

config

The config tool is used set port and adapter settings

Syntax

Syntax for --cmd set:
Config --cmd set --port <port number> --adapter <adapter number>
       [--help]
       [--speed <10M | 100M | 1G | 10G>]
       [--duplex <half | full>]
       [--mdi <Auto | MDI | MDIX>]
       [--autoneg <on | off>]
       [--ifgmin <value>]
       [--ifgmax <value>]
       [--timestamp [<value> | current]]
       [--advfull <10M | 100M | 1G>]
       [--advhalf <10M | 100M | 1G>]
       [--txpower <on | off>]
       [--sensor [<sensor number>]]
       [--high <max limit>]
       [--low <min limit>]
       [--model]
       [--enable <yes | no>]
       [--bypass]
       [--bypass_current_state < normal | bypass >]
       [--bypass_oninit_state < normal | bypass >]
       [--bypass_wdtfail_state < normal | bypass >]
       [--bypass_pwrfail_state < normal | bypass >]
       [--bypass_pwrfail_detect < on | off >]
       [--bypass_pwrfail_switch_delay <value>]
       [--host_loopback <on | off>]
       [--line_loopback <on | off>]
       [--ptp_delasym <value>]

Syntax for --cmd get:
Config --cmd get --port <port number> --adapter <adapter number>
       [--help]
       [--timestamp]
       [--sensor
       [--model]
       [--bypass]

Mandatory Commands
Command Description
--cmd <set | get> Specifies the operation of the tool
  • set
    Specifies that config sets up a parameter
  • get
    Specifies that config reads and displays the parameter
--adapter <adapter number> Specifies the adapter that the tool is to operate on. <adapter number> can have the values 0, 1, 2, etc.
The adapter parameter is mandatory for the commands that operate on an adapter.
--port <port number> Specifies the port that the tool is to operate on.
<port number> can have the values 0, 1, 2, ...
The port parameter is mandatory for the commands that operate on a port.


Optional Commands that Operate on a Port
Command Description
--help Displays a help message describing the tool including syntax and parameters
--speed <10M | 100M | 1G | 10G> Sets the link speed for a port.
This parameter is only relevant to a trispeed copper module.
Auto negotiation must be set off in order to have any effect. Set auto negotiation on in order to select max speed.
  • 10M
    10 Mbit/s
  • 100M
    100 Mbit/s
--duplex <half | full> Sets the duplex mode
  • half
    Uses half duplex mode
  • full
    Uses full duplex mode
--mdi <Auto | MDI | MDIX> Specifies whether cables are crossed
  • Auto
    Specifies that the adapter will try to determine whether the cables are crossed (Auto)
  • MDI
    Specifies that cables are not crossed (MDI - medium dependent interface)
  • MDIX
    Specifies that cables are crossed (MDIX - medium dependent interface, crossover)
--autoneg <on | off> Sets the auto negotiation mode.
  • on
    Turns on auto negotiation.
  • off
    Turns off auto negotiation.
--ifgmin <value> Sets the minimum interframe gap in units of 10ns. A specified value will be rounded up or down to the nearest value supported by the hardware, which depends on the link speed. The default minimum gap is 0 ns.
--ifgmax <value> Sets the maximum interframe gap in units of 10ns. A specified value will be rounded up or down to the nearest value supported by the hardware, which depends on the link speed. The default maximum gap is the maximum HW-supported value. Setting the maximum interframe gap to 0 ns, corresponds to disabling the check for maximum IFG.
--advfull <10M | 100M | 1G> Specifies the link capabilities that are advertised to auto negotiate full duplex
  • 10M
    Link speed 10Mbit/s is supported
  • 100M
    Link speed 100Mbit/s is supported
  • 1G
    Link speed 1Gbit/s is supported
--advhalf <10M | 100M | 1G> Specifies the link capabilities that are advertised to auto negotiate half duplex
  • 10M
    Link speed 10 Mbit/s is supported
  • 100M
    Link speed 100 Mbit/s is supported
  • 1G
    Link speed 1 Gbit/s is supported
--txpower <on | off> Sets the TX power mode - on fiber modules this controls the laser on/off mode
  • on
    Turns on the TX power
  • off
    Turns off the TX power
--enable <yes | no> Disable or enable a port
  • yes
    Enables a port
  • no
    Disables a port
--host_loopback <on | off> Sets the host loopback mode. For information, see NtPortSettings_v2_s::hostLoopback.
  • on
    Enables host loopback. If line loopback is on this is silently turned off
  • off
    Disables host loopback
--line_loopback <on | off> Sets the line loopback mode. For information, see NtPortSettings_v2_s::lineLoopback.
  • on
    Enables line loopback. If host loopback is on this is silently turned off
  • off
    Disables line loopback
--sensor [<sensor number>] Lists or sets the sensor limits for a port
  • Sensor list
    To list all sensors for a port, use the command without a parameter
  • Set sensor limits
    To set the sensor limits the sensor number to set must be used
    --sensor X where X is the sensor number
    Note: When setting sensor limits, an equal sign must be used
--high <Upper sensor limit> Sets the maximum value allowed for a sensor before an alarm is triggered.
Reset the limits to factory settings by setting --high and --low to 0.
Note: It is not possible to set a limit that is higher than the factory value.
--low <Lower sensor limit> Sets the minimum value allowed for a sensor before an alarm is triggered.
Reset the limits to factory settings by setting --high and --low to 0.
Note: It is not possible to set a limit that is lower than the factory value.
--model

Displays the vendor information of the Network interface module (NIM)

--bypass
Lists bypass related states and values
--bypass_current_state < normal | bypass > Sets bypass current state
  • normal
    Portset current state is switched into normal mode
  • bypass
    Portset current state is switched into bypass mode
--bypass_oninit_state < normal | bypass > Sets bypass oninit state
  • normal
    Portset oninit state is set up to normal mode
  • bypass
    Portset oninit state is set up to bypass mode
--bypass_wdtfail_state < normal | bypass > Sets bypass watchdog fail state
  • normal
    Portset watchdog fail state is set up to normal mode
  • bypass
    Portset watchdog fail state is set up to bypass mode
--bypass_pwrfail_state < normal | bypass > Sets bypass power fail state
  • normal
    Portset power fail state is set up to normal mode
  • bypass
    Portset power fail state is set up to bypass mode
--bypass_pwrfail_detect < on | off > Enables or disabled bypass power fail detect
  • on
    Enables bypass power fail detection
  • off
    Disables bypass power fail detection
--bypass_pwrfail_switch_delay <value> Sets bypass power fail switch delay in milliseconds


Optional Commands that Operate on an Adapter
Command Description
--timestamp [<value> | current] Sets the adapter time to the specified value
  • value
    Sets the adapter time to a value — the format of the value is decided by the timestamp (ns)
    Note: Use --timestamp XXXXXXX
  • current
    Sets the adapter time to the current OS time
    Note: Use --timestamp current
--sensor [<sensor number>] Lists or sets the sensor limits for a port
  • Sensor list
    To list all sensors for a port, use the command without a parameter
  • Set sensor limits
    To set the sensor limits, the sensor number to set must be used: --sensor X where X is the sensor number
    Note: When setting sensor limits, an equal sign must be used
--high <Upper sensor limit> Sets the maximum value allowed for a sensor before an alarm is triggered. Reset the limits to factory settings by setting --high and --low to 0.
Note: It is not possible to set a limit that is higher than the factory value.
--low <Lower sensor limit>

Sets the minimum value allowed for a sensor before an alarm is triggered. Reset the limits to factory settings by setting --high and --low to 0.
Note: It is not possible to set a limit that is lower than the factory value.

--bypass
Lists bypass related states and values
--bypass_current_state < normal | bypass > Sets bypass current state for all portsets on the adapter
  • normal
    All portset (current) states are switched into normal mode
  • bypass
    All portset (current) states are switched into bypass mode
--bypass_oninit_state < normal | bypass > Sets bypass oninit state
  • normal
    All portset oninit states are set up to normal mode
  • bypass
    All portset oninit states are set up to bypass mode
--bypass_wdtfail_state < normal | bypass > Sets bypass watchdog fail states for all portsets on the adapter
  • normal
    All portset watchdog fail states are set up to normal mode
  • bypass
    All portset watchdog fail states are set up to bypass mode
--bypass_pwrfail_state < normal | bypass > Sets bypass power fail states for all portsets on the adapter
  • normal
    All portset power fail states are set up to normal mode
  • bypass
    All portset power fail states are set up to bypass mode
--bypass_pwrfail_detect < on | off > Enables or disabled bypass power fail detect
  • on
    Enables bypass power fail detection
  • off
    Disables bypass power fail detection
--bypass_pwrfail_switch_delay <value> Sets bypass power fail switch delay in milliseconds
--ptp_delasym <value>

Sets the PTP delay asymmetry compensation parameter in units of 1 ns


Parameters supported by different adapters
NT4E,
NT4E-STD,
NT4E2-4T-BP,
NT4E2-4-PTP
NT20E,
NT20E2,
NT20E2-PTP,
NT40E2-4
NT40E2-1 NT20E3-2-PTP,
NT40E3-4-PTP
NT80E3_2_PTP,
NT100E3-1-PTP,
NT200A01
Link speed
--speed
x3  x1 
Duplex
--duplex
x2,3    
MDI
--mdi
x2,3  x2 
Auto negotiation
--autoneg
x2,3    
Minimum interframe gap
--ifgmin
xxxxx
Maximum interframe gap
--ifgmax
xxxxx
Adapter time
--timestamp
xxxxx
Full duplex advertising
--advfull
x2,3    
Half duplex advertising
--advhalf
x2,3    
TX power mode
--txpower
xxxxx
  1. With a dual rate 1G/10G nim module
  2. With a 1G cupper nim module
  3. With a tri-speed nim module

Examples

  • Read port setting from port 2
    config --cmd get --port 2
  • Read adapter time from adapter 0
    config --cmd get --adapter 0 --timestamp
  • Set adapter time on adapter 0
    config --cmd set --adapter 0 --timestamp 0x236648825649
  • Set adapter time to current OS time on adapter 0.
    config --cmd set --adapter 0 --timestamp current
    Note: Does not work with time stamp type equal to native
  • Set link speed to 100MBit/s on port 3
    config --cmd set --port 3 --speed 100M -autoneg off
  • Set interframe gaps on port 3
    config --cmd set --port 3 --ifgmin 10 --ifgmax 1000
  • Set advertised speeds and enable auto negotiation on port 3
    config --cmd set --port 3 --advfull 10M,100M,1G --advhalf 10M,100M --autoneg on
  • List all sensor limits for adapter 1
    config --cmd get --adapter 1 --sensor
    Output:
    Adapter  1 sensors:
    -------------------
      Sensor  0 Min limit:    0 Max limit:  900 Current:  630 Name: FPGA       Type: temperature
      Sensor  1 Min limit:  550 Max limit:  690 Current:    0 Name: FAN        Type: fan
      Sensor  2 Min limit: -400 Max limit: 1250 Current:  720 Name: Ex1 Temp   Type: temperature
      Sensor  3 Min limit: -400 Max limit: 1250 Current:  670 Name: Ex2 Temp   Type: temperature
      Sensor  4 Min limit: -400 Max limit: 1250 Current:  620 Name: Fro Exar   Type: temperature
      Sensor  5 Min limit:    0 Max limit:  850 Current:  620 Name: Fro PCB    Type: temperature
    
  • Set limits for adapter 1 sensor 5
    config --cmd set --adapter 1 --sensor 5 --low 0 --high 700
    Output:
    Setting adapter 1 sensor 5 to low 0 and high 700
    
  • Reset limits for adapter 1 sensor 5 to factory defaults
    config --cmd set --adapter 1 --sensor 5 --low -0 --high 0
    Output:
    Resetting adapter 1 sensor 5 factory defaults
    
  • List all sensor limits for port 3.
    config --cmd get --port 3 --sensor
    Output:
    Port  3 sensors:
    ----------------
      Sensor  0 Min limit:  -50 Max limit:  750 Current:  680 Name: SFP+       Type: temperature
    
  • Set limits for port 3
    config --cmd set --port 3 --sensor 0 --low 0 --high 700
    Output:
    Setting port 3 sensor 0 to low 0 and high 700
    
  • Reset limits for port 3
    config --cmd set --port 3 --sensor 0 --low 0 --high 0
    Output:
    Resetting port 3 sensor 0 factory defaults
    
  • Read bypass port states for the port set that port 1 belongs to
    config --cmd get --port 1 --bypass
  • Read bypass port states port sets on adapter 1
    config --cmd get --adapter 1 --bypass
  • Switch bypass current state — for the port set that port 1 belongs to — to normal
    config --cmd set --port 1 --bypass_current_state normal
  • Switch bypass current states to bypass — for all port sets on adapter 1
    config --cmd set --adapter 1 --bypass_current_state bypass
  • Set up bypass current,oninit,pwrfail,wdtfail states — for the port set that port 1 belongs to
    config --cmd set --port 1 --bypass_current_state normal --bypass_oninit_state normal --bypass_pwrfail_state bypass --bypass_wdtfail_state bypass
  • Set up bypass current,oninit,pwrfail,wdtfail states — for all port sets on adapter 1
    config --cmd set --adapter 1 --bypass_current_state normal --bypass_oninit_state normal --bypass_pwrfail_state bypass --bypass_wdtfail_state bypass