Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Caption
0Figure
1IMF Objects Groupings

Pagebreak


IMF Command Set Information

...

Div
stylepadding-left:3%;

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>];

Pagebreak


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

Noprint

Click to read more...

Toggle Cloak


Cloak
titleClick to read more...

SLOT - Slot
Permission: Createable
Type: int
Description: IMF Connection slot number.

INTERFACE - Interface
Permission: Createable
Type: IMFInterface={PT DEFAULT}
Description: IMF Connection interface (PT_DEFAULT).

IP_PROTOCOL - IP Protocol
Permission: Createable
Type: IMFIPProtocol={TCP}
Description: IMF Connection IP protocol (TCP only).

TRAFFIC_DIR - Traffic Direction
Permission: Writeable
Type: IMFTrafficDir={ALL,INCOMING,OUTGOING}
Description: Interface supported traffic direction. Valid values: ALL, INCOMING, and OUTGOING. Default value: ALL.

LOCAL_IPADDR1 - Local IP Address 1
Permission: Writeable
Type: string
Description: Primary local IP address of this IMF Connection. This may be a hostname provisioned in /etc/hosts or an IP Address. This information is only used if the connection IP Protocol attribute is set to SCTP. TCP/IP does not require knowledge of the local address.

LOCAL_IPADDR2 - Local IP Address 2
Permission: Writeable
Type: string
Description: Secondary local IP address of this IMF Connection. This may be a hostname provisioned in /etc/hosts or an IP Address. This information is only used if the connection IP Protocol attribute is set to SCTP. TCP/IP does not require knowledge of the local address.

LOCAL_L2PORT - Local Port
Permission: Writeable
Type: int(Range: [0..65535]
Description: Local port of this IMF Connection. This information is only used if the connection IP Protocol attribute is set to SCTP. TCP/IP does not require knowledge of the local port, will be assigned internally.


REMOTE_IPADDR1 - Remote IP Address 1
Permission: Writeable
Type: string
Description: Primary remote IP address of this IMF Connection. This may be a hostname provisioned in /etc/hosts or an IP Address. This is the address of the IMF 3rd party probe.

REMOTE_IPADDR2 - Remote IP Address 2
Permission: Writeable
Type: string
Description: Secondary remote IP address of this IMF Connection. This may be a hostname provisioned in /etc/hosts or an IP Address. This information is only used if the connection IP Protocol attribute is set to SCTP. TCP/IP does not require knowledge of the local address.

REMOTE_L2PORT - Remote Port
Permission: Writeable
Type: int(Range: [0..65535])
Description: Remote port of this IMF Connection. This is the port of the IMF 3rd party probe.

STATUS - Status
Permission: Read-only
Type: IMFConnStatus={NOT APPLICABLE,INACTIVE,NOT CONNECTED,CONNECTED}
Description: IMF Connection status (NOT APPLICABLE/INACTIVE/NOT CONNECTED/CONNECTED. NOT APPLICABLE only applies to UDP protocol.

CONNID - Connection ID
Permission: Read-only
Type: int
Description: Internal hidden attribute


...

Div
stylepadding-left:3%;

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>;pagebreak


AID Description

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

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

Attribute Details

Noprint

Click to read more...

Toggle Cloak


Cloak
titleClick to read more...

NAME - Name
Read-only
Type: string
Description: IMF Traffic Process name.

SLOT - Slot
Read-only
Type: int
Description: IMF Traffic Process slot.

VERSION - Version
Permission: Read-only
Type: int
Description: IMF Traffic Process version.


...

Div
stylepadding-left:3%;

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>;

Pagebreak


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.

...