[python source code]

lan

The lan commands module.

These commands are used in the following models: MP5103

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- lan.applysettings()
- lan.autoconnect
- lan.config.dns.address[N]
- lan.config.dns.domain
- lan.config.dns.dynamic
- lan.config.dns.hostname
- lan.config.dns.verify
- lan.config.gateway
- lan.config.ipaddress
- lan.config.method
- lan.config.subnetmask
- lan.enable
- lan.hislip.access
- lan.identify
- lan.ipconfig()
- lan.linktimeout
- lan.nagle
- lan.rawsocket.access
- lan.reset()
- lan.restoredefaults()
- lan.status.dns.address[N]
- lan.status.dns.name
- lan.status.gateway
- lan.status.ipaddress
- lan.status.macaddress
- lan.status.port.dst
- lan.status.port.hislip
- lan.status.port.rawsocket
- lan.status.port.telnet
- lan.status.speed
- lan.status.subnetmask
- lan.telnet.access

Lan

Bases: BaseTSPCmd

The lan command tree.

Properties and methods
  • .applysettings(): The lan.applysettings() function.
  • .autoconnect: The lan.autoconnect attribute.
  • .config: The lan.config command tree.
  • .enable: The lan.enable attribute.
  • .hislip: The lan.hislip command tree.
  • .identify: The lan.identify attribute.
  • .ipconfig(): The lan.ipconfig() function.
  • .linktimeout: The lan.linktimeout attribute.
  • .nagle: The lan.nagle attribute.
  • .rawsocket: The lan.rawsocket command tree.
  • .reset(): The lan.reset() function.
  • .restoredefaults(): The lan.restoredefaults() function.
  • .status: The lan.status command tree.
  • .telnet: The lan.telnet command tree.

autoconnect property writable 

autoconnect: str

Access the lan.autoconnect attribute.

Description
  • This attribute is used to enable or disable link monitoring.
Usage
  • Accessing this property will send the print(lan.autoconnect) query.
  • Setting this property to a value will send the lan.autoconnect = value command.
TSP Syntax 
- lan.autoconnect = value
- print(lan.autoconnect)
Raises:

config property 

config: LanConfig

Return the lan.config command tree.

Sub-properties and sub-methods
  • .dns: The lan.config.dns command tree.
  • .gateway: The lan.config.gateway attribute.
  • .ipaddress: The lan.config.ipaddress attribute.
  • .method: The lan.config.method attribute.
  • .subnetmask: The lan.config.subnetmask attribute.

enable property writable 

enable: str

Access the lan.enable attribute.

Description
  • This attribute controls whether or not any communications using the LAN connector are enabled.
Usage
  • Accessing this property will send the print(lan.enable) query.
  • Setting this property to a value will send the lan.enable = value command.
TSP Syntax 
- lan.enable = value
- print(lan.enable)
Raises:

hislip property 

hislip: LanHislip

Return the lan.hislip command tree.

Sub-properties and sub-methods
  • .access: The lan.hislip.access attribute.

identify property writable 

identify: str

Access the lan.identify attribute.

Description
  • This attribute controls the LXI LAN identify state.
Usage
  • Accessing this property will send the print(lan.identify) query.
  • Setting this property to a value will send the lan.identify = value command.
TSP Syntax 
- lan.identify = value
- print(lan.identify)
Raises:

linktimeout property writable 

linktimeout: str

Access the lan.linktimeout attribute.

Description
  • This attribute contains the LAN link timeout period.
Usage
  • Accessing this property will send the print(lan.linktimeout) query.
  • Setting this property to a value will send the lan.linktimeout = value command.
TSP Syntax 
- lan.linktimeout = value
- print(lan.linktimeout)
Info
  • timeout, the LAN link monitor time-out period (in seconds).
Raises:

nagle property writable 

nagle: str

Access the lan.nagle attribute.

Description
  • This attribute controls the state of the LAN Nagle algorithm.
Usage
  • Accessing this property will send the print(lan.nagle) query.
  • Setting this property to a value will send the lan.nagle = value command.
TSP Syntax 
- lan.nagle = value
- print(lan.nagle)
Raises:

rawsocket property 

rawsocket: LanRawsocket

Return the lan.rawsocket command tree.

Sub-properties and sub-methods
  • .access: The lan.rawsocket.access attribute.

status property 

status: LanStatus

Return the lan.status command tree.

Sub-properties and sub-methods
  • .dns: The lan.status.dns command tree.
  • .gateway: The lan.status.gateway attribute.
  • .ipaddress: The lan.status.ipaddress attribute.
  • .macaddress: The lan.status.macaddress attribute.
  • .port: The lan.status.port command tree.
  • .speed: The lan.status.speed attribute.
  • .subnetmask: The lan.status.subnetmask attribute.

telnet property 

telnet: LanTelnet

Return the lan.telnet command tree.

Sub-properties and sub-methods
  • .access: The lan.telnet.access attribute.

applysettings 

applysettings() -> None

Run the lan.applysettings() function.

Description
  • This function re-initializes the LAN interface with new settings.
TSP Syntax 
- lan.applysettings()
Raises:

ipconfig 

ipconfig(
    method: str | None = None,
    ip_v4_address: str | None = None,
    subnet_mask: str | None = None,
    gateway: str | None = None,
) -> str

Run the lan.ipconfig() function.

Description
  • This function specifies the LAN configuration for the instrument.
TSP Syntax 
- lan.ipconfig()
Parameters:
  • method (optional, default: None ) –

    The method for configuring LAN settings; it can be one of the following values.

  • ip_v4_address (optional, default: None ) –

    LAN IP address; must be a string specifying the IP address in dotted decimal notation.

  • subnet_mask (optional, default: None ) –

    The LAN subnet mask; must be a string in dotted decimal notation.

  • gateway (optional, default: None ) –

    The LAN default gateway; must be a string in dotted decimal notation.
Returns:
  • str –

    The result of the function call.
Raises:

reset 

reset() -> None

Run the lan.reset() function.

Description
  • This function resets the LAN interface.
TSP Syntax 
- lan.reset()
Raises:

restoredefaults 

restoredefaults() -> None

Run the lan.restoredefaults() function.

Description
  • This function resets LAN settings to default values.
TSP Syntax 
- lan.restoredefaults()
Raises:

LanConfig

Bases: BaseTSPCmd

The lan.config command tree.

Properties and methods
  • .dns: The lan.config.dns command tree.
  • .gateway: The lan.config.gateway attribute.
  • .ipaddress: The lan.config.ipaddress attribute.
  • .method: The lan.config.method attribute.
  • .subnetmask: The lan.config.subnetmask attribute.

dns property 

dns: LanConfigDns

Return the lan.config.dns command tree.

Sub-properties and sub-methods
  • .address: The lan.config.dns.address[N] attribute.
  • .domain: The lan.config.dns.domain attribute.
  • .dynamic: The lan.config.dns.dynamic attribute.
  • .hostname: The lan.config.dns.hostname attribute.
  • .verify: The lan.config.dns.verify attribute.

gateway property writable 

gateway: str

Access the lan.config.gateway attribute.

Description
  • This attribute contains the LAN default gateway address.
Usage
  • Accessing this property will send the print(lan.config.gateway) query.
  • Setting this property to a value will send the lan.config.gateway = value command.
TSP Syntax 
- lan.config.gateway = value
- print(lan.config.gateway)
Raises:

ipaddress property writable 

ipaddress: str

Access the lan.config.ipaddress attribute.

Description
  • This command specifies the LAN IP address.
Usage
  • Accessing this property will send the print(lan.config.ipaddress) query.
  • Setting this property to a value will send the lan.config.ipaddress = value command.
TSP Syntax 
- lan.config.ipaddress = value
- print(lan.config.ipaddress)
Raises:

method property writable 

method: str

Access the lan.config.method attribute.

Description
  • This attribute contains the LAN settings configuration method.
Usage
  • Accessing this property will send the print(lan.config.method) query.
  • Setting this property to a value will send the lan.config.method = value command.
TSP Syntax 
- lan.config.method = value
- print(lan.config.method)
Raises:

subnetmask property writable 

subnetmask: str

Access the lan.config.subnetmask attribute.

Description
  • This attribute contains the LAN subnet mask.
Usage
  • Accessing this property will send the print(lan.config.subnetmask) query.
  • Setting this property to a value will send the lan.config.subnetmask = value command.
TSP Syntax 
- lan.config.subnetmask = value
- print(lan.config.subnetmask)
Info
  • mask, the string that specifies the LAN subnet mask value in dotted decimal notation.
Raises:

LanConfigDns

Bases: BaseTSPCmd

The lan.config.dns command tree.

Properties and methods
  • .address: The lan.config.dns.address[N] attribute.
  • .domain: The lan.config.dns.domain attribute.
  • .dynamic: The lan.config.dns.dynamic attribute.
  • .hostname: The lan.config.dns.hostname attribute.
  • .verify: The lan.config.dns.verify attribute.

address property 

address: dict[int, str | float]

Access the lan.config.dns.address[N] attribute.

Description
  • This command configures the DNS server IP addresses.
Usage
  • Accessing an item from this property will send the print(lan.config.dns.address[N]) query.
  • Setting an item from this property to a value will send the lan.config.dns.address[N] = value command.
TSP Syntax 
- lan.config.dns.address[N] = value
- print(lan.config.dns.address[N])
Info
  • N, the entry index: 1 or 2.
Raises:

domain property writable 

domain: str

Access the lan.config.dns.domain attribute.

Description
  • This attribute configures the dynamic DNS domain.
Usage
  • Accessing this property will send the print(lan.config.dns.domain) query.
  • Setting this property to a value will send the lan.config.dns.domain = value command.
TSP Syntax 
- lan.config.dns.domain = value
- print(lan.config.dns.domain)
Raises:

dynamic property writable 

dynamic: str

Access the lan.config.dns.dynamic attribute.

Description
  • Enables or disables the dynamic DNS registration.
Usage
  • Accessing this property will send the print(lan.config.dns.dynamic) query.
  • Setting this property to a value will send the lan.config.dns.dynamic = value command.
TSP Syntax 
- lan.config.dns.dynamic = value
- print(lan.config.dns.dynamic)
Raises:

hostname property writable 

hostname: str

Access the lan.config.dns.hostname attribute.

Description
  • This attribute defines the dynamic DNS host name.
Usage
  • Accessing this property will send the print(lan.config.dns.hostname) query.
  • Setting this property to a value will send the lan.config.dns.hostname = value command.
TSP Syntax 
- lan.config.dns.hostname = value
- print(lan.config.dns.hostname)
Raises:

verify property writable 

verify: str

Access the lan.config.dns.verify attribute.

Description
  • This attribute defines the DNS host name verification state.
Usage
  • Accessing this property will send the print(lan.config.dns.verify) query.
  • Setting this property to a value will send the lan.config.dns.verify = value command.
TSP Syntax 
- lan.config.dns.verify = value
- print(lan.config.dns.verify)
Raises:

LanHislip

Bases: BaseTSPCmd

The lan.hislip command tree.

Properties and methods
  • .access: The lan.hislip.access attribute.

access property writable 

access: str

Access the lan.hislip.access attribute.

Description
  • This command is used to enable or disable mainframe HiSLIP port communications.
Usage
  • Accessing this property will send the print(lan.hislip.access) query.
  • Setting this property to a value will send the lan.hislip.access = value command.
TSP Syntax 
- lan.hislip.access = value
- print(lan.hislip.access)
Raises:

LanRawsocket

Bases: BaseTSPCmd

The lan.rawsocket command tree.

Properties and methods
  • .access: The lan.rawsocket.access attribute.

access property writable 

access: str

Access the lan.rawsocket.access attribute.

Description
  • This command is used to enable or disable mainframe raw socket port communications
Usage
  • Accessing this property will send the print(lan.rawsocket.access) query.
  • Setting this property to a value will send the lan.rawsocket.access = value command.
TSP Syntax 
- lan.rawsocket.access = value
- print(lan.rawsocket.access)
Raises:

LanStatus

Bases: BaseTSPCmd

The lan.status command tree.

Properties and methods
  • .dns: The lan.status.dns command tree.
  • .gateway: The lan.status.gateway attribute.
  • .ipaddress: The lan.status.ipaddress attribute.
  • .macaddress: The lan.status.macaddress attribute.
  • .port: The lan.status.port command tree.
  • .speed: The lan.status.speed attribute.
  • .subnetmask: The lan.status.subnetmask attribute.

dns property 

dns: LanStatusDns

Return the lan.status.dns command tree.

Sub-properties and sub-methods
  • .address: The lan.status.dns.address[N] attribute.
  • .name: The lan.status.dns.name attribute.

gateway property 

gateway: str

Access the lan.status.gateway attribute.

Description
  • This attribute contains the gateway address presently in use by the LAN interface.
Usage
  • Accessing this property will send the print(lan.status.gateway) query.
TSP Syntax 
- print(lan.status.gateway)
Raises:

ipaddress property 

ipaddress: str

Access the lan.status.ipaddress attribute.

Description
  • This attribute contains the LAN IP address presently in use by the LAN interface.
Usage
  • Accessing this property will send the print(lan.status.ipaddress) query.
TSP Syntax 
- print(lan.status.ipaddress)
Raises:

macaddress property 

macaddress: str

Access the lan.status.macaddress attribute.

Description
  • This attribute contains the LAN MAC address.
Usage
  • Accessing this property will send the print(lan.status.macaddress) query.
TSP Syntax 
- print(lan.status.macaddress)
Raises:

port property 

port: LanStatusPort

Return the lan.status.port command tree.

Info
  • port, the dST port number.
Sub-properties and sub-methods
  • .dst: The lan.status.port.dst attribute.
  • .hislip: The lan.status.port.hislip attribute.
  • .rawsocket: The lan.status.port.rawsocket attribute.
  • .telnet: The lan.status.port.telnet attribute.

speed property 

speed: str

Access the lan.status.speed attribute.

Description
  • This attribute contains the LAN speed.
Usage
  • Accessing this property will send the print(lan.status.speed) query.
TSP Syntax 
- print(lan.status.speed)
Raises:

subnetmask property 

subnetmask: str

Access the lan.status.subnetmask attribute.

Description
  • This attribute contains the LAN subnet mask that is presently in use by the LAN interface.
Usage
  • Accessing this property will send the print(lan.status.subnetmask) query.
TSP Syntax 
- print(lan.status.subnetmask)
Info
  • mask, a string specifying the subnet mask in dotted decimal notation.
Raises:

LanStatusDns

Bases: BaseTSPCmd

The lan.status.dns command tree.

Properties and methods
  • .address: The lan.status.dns.address[N] attribute.
  • .name: The lan.status.dns.name attribute.

address property 

address: dict[int, str | float]

Access the lan.status.dns.address[N] attribute.

Description
  • This attribute contains the DNS server IP addresses.
Usage
  • Accessing an item from this property will send the print(lan.status.dns.address[N]) query.
TSP Syntax 
- print(lan.status.dns.address[N])
Info
  • N, the entry index: 1, 2, or 3.
Raises:

name property 

name: str

Access the lan.status.dns.name attribute.

Description
  • This attribute contains the present DNS fully qualified host name.
Usage
  • Accessing this property will send the print(lan.status.dns.name) query.
TSP Syntax 
- print(lan.status.dns.name)
Raises:

LanStatusPort

Bases: BaseTSPCmd

The lan.status.port command tree.

Info
  • port, the dST port number.
Properties and methods
  • .dst: The lan.status.port.dst attribute.
  • .hislip: The lan.status.port.hislip attribute.
  • .rawsocket: The lan.status.port.rawsocket attribute.
  • .telnet: The lan.status.port.telnet attribute.

dst property 

dst: str

Access the lan.status.port.dst attribute.

Description
  • This attribute contains the LAN dead socket termination (DST) port number.
Usage
  • Accessing this property will send the print(lan.status.port.dst) query.
TSP Syntax 
- print(lan.status.port.dst)
Info
  • port, the dST port number.
Raises:

hislip property 

hislip: str

Access the lan.status.port.hislip attribute.

Description
  • This attribute contains the HiSLIP connection port number.
Usage
  • Accessing this property will send the print(lan.status.port.hislip) query.
TSP Syntax 
- print(lan.status.port.hislip)
Info
  • port, the hiSLIP port number, 4880.
Raises:

rawsocket property 

rawsocket: str

Access the lan.status.port.rawsocket attribute.

Description
  • This attribute contains the LAN raw socket connection port number.
Usage
  • Accessing this property will send the print(lan.status.port.rawsocket) query.
TSP Syntax 
- print(lan.status.port.rawsocket)
Info
  • port, the raw socket port number, 5025.
Raises:

telnet property 

telnet: str

Access the lan.status.port.telnet attribute.

Description
  • This attribute contains the LAN telnet connection port number.
Usage
  • Accessing this property will send the print(lan.status.port.telnet) query.
TSP Syntax 
- print(lan.status.port.telnet)
Info
  • port, the telnet port number.
Raises:

LanTelnet

Bases: BaseTSPCmd

The lan.telnet command tree.

Properties and methods
  • .access: The lan.telnet.access attribute.

access property writable 

access: str

Access the lan.telnet.access attribute.

Description
  • This command is used to enable or disable mainframe telnet port communications
Usage
  • Accessing this property will send the print(lan.telnet.access) query.
  • Setting this property to a value will send the lan.telnet.access = value command.
TSP Syntax 
- lan.telnet.access = value
- print(lan.telnet.access)
Raises: