8.3.2.1. Module
This module contains the L47 module classes.
- class M4_CAPTURE_FILE_DELETE[source]
Bases:
objectCommand to delete a Capture File (
.pcapfile) in the Capture File directory (/var/ftp/pub/replay/pcap/). For information about the location and directory structure for the Capture Files, see: M4_REPLAY_PARSE_START
- class M4_CAPTURE_FILE_LIST[source]
Bases:
objectReturns a list of Capture Files (
.pcapfiles) in the ‘user’ Capture File directory (/var/ftp/pub/replay/pcap/user/).
- class M4_CAPTURE_FILE_LIST_BSON[source]
Bases:
objectWorks as
M4_CAPTURE_FILE_LIST, but returns the file list formatted as a BSON document.
- class M4_CAPTURE_SIZE[source]
Bases:
objectSpecify whether to capture whole packets(large) or truncated packets. When truncated (small) is selected only the first 128 bytes of the packet are saved.
- get()[source]
Get whether to capture whole packets(large) or truncated packets.
- Returns:
whether to capture whole packets(large) or truncated packets.
- Return type:
M4_CAPTURE_SIZE.GetDataAttr
- set(size)[source]
Set whether to capture whole packets(large) or truncated packets.
- Parameters:
size (CaptureSize) – specifying whether to capture whole packets or truncated packets.
- set_full()
Capture whole packets
- set_small()
Capture truncated packets
- class M4_COMPATIBLE_CLIENT_VERSION[source]
Bases:
objectReturns the recommended and required VulcanMananger client version.
- class M4_LICENSE_INFO[source]
Bases:
objectReturns the number of available and free PE licenses. Only ‘available’ number of PEs can simultaneously be assigned to reserved ports.
- class M4_REPLAY_FILE_DELETE[source]
Bases:
objectCommand to delete a Replay File (
.bsonfile) in the Replay File directory (/var/ftp/pub/replay/bson/). For information about the location and directory structure for the Replay Files, see: M4_REPLAY_PARSE_START
- class M4_REPLAY_FILE_LIST[source]
Bases:
objectReturns a list of Replay Files (
.bsonfiles) in the ‘user’ Replay File directory (/var/ftp/pub/replay/bson/user/).
- class M4_REPLAY_FILE_LIST_BSON[source]
Bases:
objectWorks as
M4_REPLAY_FILE_LIST, but returns the file list formatted as a BSON document.
- class M4_REPLAY_PARSER_PARAMS[source]
Bases:
objectConfiguration of parameters for the parsing of pcap files.
- class M4_REPLAY_PARSE_START[source]
Bases:
objectCommand to start parsing an uploaded Capture File (in PCAP format) intended for use in a replay test scenario. The result of the parsing - if successful - is a Replay File (in BSON format) with the same name as the Capture File, which can be used as parameter to P4G_REPLAY_filename command. If parsing is unsuccessful, a Replay File is created containing the parse result. The M4_REPLAY_FILE_INFO_BSON command can be used to get information about a Replay File - including the parse result. PCAP Capture Files can be uploaded to the L47 chassis using FTP. The ‘root’ location of Capture Files uploaded manually by the user is /var/ftp/pub/replay/pcap/. Three subdirectories exist: cache/, user/ and xena/. cache / and xena/ is used by Vulcan Manager, and user/ is intended for manual upload and parsing of Capture Files. A similar directory structure is present for Replay Files generated by the parsing, and the ‘root’ location is /var/ftp/pub/replay/bson/.
- class M4_REPLAY_PARSE_STATE[source]
Bases:
objectOnly one Capture File can be parsed at a time. This command returns the state of the parser, which can be PARSING or OFF. M4_REPLAY_PARSE_START command is only accepted when the parser state is OFF.
- class M4_REPLAY_PARSE_STOP[source]
Bases:
objectCommand to stop parsing a Capture File. Parsing of very large Capture Files may take several seconds, and may be aborted using this command. No parameters
- class M4_SYSTEM_STATUS[source]
Bases:
objectReturns the L47 module system status in a text string.
- class M4_SYSTEM_TIME[source]
Bases:
objectSets or returns the modules system time in UTC.