You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

In this section:


This section describes the commands related to the Integrated Monitoring Feed (IMF).

Note

Verbs and modifiers are separated by hyphens ( - ), attribute fields (TID, AID, CTAG, and General Block) are separated by colons (:), and every command is terminated by a semicolon (;).

Any attribute that contains TL1 special characters [ equal signs ( = ), colons ( : ), dashes ( - ), and commas ( , ) ] should be enclosed in double quotes ( " ) to help the attribute values escape.

Refer to Input Command Structure for more information.

IMF Command Groupings

The following figure lists the IMF objects that can be configured using TL1 commands.

IMF Objects Groupings

IMF Command Set Information

This section includes information for the IMF command set.

IMF Configuration

CHG-IMF-CFG

CHG-IMF-CFG:::[CTAG]:::::[ERRORS=<LogBoolean>],[SETUP_MGMT=<LogBoolean>],[EXEC_TRACE=<LogBoolean>],[PEER_MGMT=<LogBoolean>];

VFY-IMF-CFG

VFY-IMF-CFG:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];

SET-IMF-CFG

SET-IMF-CFG:::[CTAG]:::[RESTORE_DBG];

Response Format

:::<VERSION=int>,<LICENSE=IMFLicense>,<ERRORS=LogBoolean>,<SETUP_MGMT=LogBoolean>,<EXEC_TRACE=LogBoolean>,<PEER_MGMT=LogBoolean>;

Attribute Details

Click to read more...

IMF Connections

VFY-IMF-CXS

VFY-IMF-CXS:::[CTAG];

Response Format

:::<COUNT=int>;

Attribute Details

COUNT - Count
Permissions: Read-only
Type: int
Description: Number of IMF Connections.

IMF Connection

DLT-IMF-CX

DLT-IMF-CX::[<IMF Connection/Name>]:[CTAG];

ADD-IMF-CX

ADD-IMF-CX::[<IMF Connection/Name>]:[CTAG]:::::[SLOT=<int>],[INTERFACE=<IMFInterface>],[IP_PROTOCOL=<IMFIPProtocol>];

CHG-IMF-CX

CHG-IMF-CX::[<IMF Connection/Name>]:[CTAG]:::::[TRAFFIC_DIR=<IMFTrafficDir>],[REMOTE_IPADDR1=<string>],[REMOTE_IPADDR2=<string>],[REMOTE_L2PORT=<int>];

SET-IMF-CX

SET-IMF-CX::[<IMF Connection/Name>]:[CTAG]:::[ACT/DEACT];

VFY-IMF-CX

VFY-IMF-CX::[<IMF Connection/Name>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];

Response Format

::[<IMF Connection/Name>]:<NAME=string>,<SLOT=int>,<INTERFACE=IMFInterface>,<IP_PROTOCOL=IMFIPProtocol>,<TRAFFIC_DIR=IMFTrafficDir>,<LOCAL_IPADDR1=string>,<LOCAL_IPADDR2=string>,<LOCAL_L2PORT=int>,<REMOTE_IPADDR1=string>,<REMOTE_IPADDR2=string>,<REMOTE_L2PORT=int>,<STATUS=IMFConnStatus>,<CONNID=int>;

AID Description

Name - Position 1
Type: string
Description: IMF Connection unique name.

Attribute Details

Click to read more...

IMF Traffic Processes

VFY-IMF-CXS

VFY-IMF-PROCS:::[CTAG];

Response Format

:::<COUNT=int>;

Attribute Details

COUNT - Count
Permissions: Read-only
Type: int
Description: Number of IMF Traffic Processes.

IMF Traffic Process

VFY-IMF-PROC

VFY-IMF-PROC::[<IMF Traffic Process/Name>-<IMF Traffic Process/Slot>]:[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];

Response Format

::[<IMF Traffic Process/Name>-<IMF Traffic Process/Slot>]:<NAME=string>,<SLOT=int>,<VERSION=int>;

AID Description

Name - Position 1
Type: string
Description: IMF Traffic Process name.

Slot - Position 2
Type: int
Description: IMF Traffic Process slot.

Attribute Details

Click to read more...

IMF Packet Capture

CHG-IMF-CAP

CHG-IMF-CAP:::[CTAG]:::::[TIME=<int>];

SET-IMF-CAP

SET-IMF-CAP:::[CTAG]:::[START/STOP];

VFY-IMF-CAP

VFY-IMF-CAP:::[CTAG]::::::[<searchedAttrKey1=Value1>][,<searchedAttrKey2=Value2>]…[,<searchedAttrKeyN=ValueN>];

Response Format

:::<TIME=int>,<STATUS=IMFCaptureStatus>;

Attribute Details

TIME - Capture Time
Permission: Writeable
Type: int
Description: Time in seconds to run the capture. When the user starts the capture, a timer is started for this many seconds. If the user does not manually stop the capture first, the capture is stopped when the timer finishes. Please wait five seconds after starting the capture before sending the desired traffic.

STATUS - Status
Permission: Read-only
Type: IMFCaptureStatus={STOPPED,RUNNING}
Description: Current status of the packet capture feature. When RUNNING, captured packets are saved to the file /var/log/packet_capture.pcap. If that file already exists, it will be overwritten. The file is accessible under File Retrieval on the web interface.


  • No labels