Identification#

Name#

Gets the name of a module.

Corresponding CLI command: M_NAME

# Name
resp = await module.name.get()
resp.name

Gets the user-defined description string of a module.

Corresponding CLI command: M_COMMENT

# Description
await module.comment.set(comment="description")

resp = await module.comment.get()
resp.comment

Gets the legacy model P/N name of a Xena test module.

Corresponding CLI command: M_MODEL

# Legacy Model
resp = await module.model.get()
resp.model

Gets the model P/N name of a Xena test module.

Corresponding CLI command: M_REVISION

# Model
resp = await module.revision.get()
resp.revision

Gets the unique serial number of a module.

Corresponding CLI command: M_SERIALNO

# Serial Number
resp = await module.serial_number.get()
resp.serial_number

Gets the version number of the hardware image installed on a module.

Corresponding CLI command: M_VERSIONNO

# Firmware Version
resp = await module.version_number.get()
resp.version

Gets the maximum number of ports on a module.

Note

For a CFP-type module this number refers to the maximum number of ports possible on the module regardless of the media configuration.

So if a CFP-type module can be set in for instance either 1x100G mode or 8x10G mode then this command will always return 8.

If you want the current number of ports for a CFP-type module you need to read the M_CFPCONFIGEXT command which returns the number of current ports.

Corresponding CLI command: M_PORTCOUNT

# Port Count
resp = await module.port_count.get()
resp.port_count

Get status readings for the test module itself.

Corresponding CLI command: M_STATUS

# Status
resp = await module.status.get()
resp.temperature