ChannelMediaGateway

Summary

Represents a Media Gateway Channel Adapter object.

Methods: ChannelMediaGateway.check_status()

ChannelMediaGateway.export_configuration()

ChannelMediaGateway.get_wakeup_line_status()

ChannelMediaGateway.import_configuration()

ChannelMediaGateway.port_enable()

ChannelMediaGateway.port_master_slave()

ChannelMediaGateway.reset_to_default()

ChannelMediaGateway.restart_device()

ChannelMediaGateway.set_dynamic()

ChannelMediaGateway.set_wakeup_line_status()
Properties: ChannelMediaGateway.cluster_name

ChannelMediaGateway.name

Structure

class ChannelMediaGateway

check_status() → str

Checks the status of the device and returns it.

Returns: Device's status.
Return type: str

export_configuration(path: str, name: str) → bool

Attempts to export a device's configuration to a file.

Parameters

path (str) – Path to export to.
name (str) – File name to save as.

Returns

True if operation was successful, False otherwise.

Return type

bool

get_wakeup_line_status() → str

Gets the wakeup line status of the device.

Returns: Device's wakeup line status.
Return type: str

import_configuration(conf_file: str) → bool

Attempts to import configuration from a file to the device.

Parameters: conf_file (str) – File containing the configuration.
Returns: True if operation was successful, False otherwise.
Return type: bool

port_enable(numPort: uint16, enableDisable: bool) → bool

Attempts to set a specific's port state to enabled or disabled.

Parameters

numPort (uint16) – Desired port number.
enableDisable (bool) – Desired port's status, True for enabled, False for disabled.

Returns

True if operation was successful (port enabled), False otherwise.

Return type

bool

port_master_slave(selected_port: int32, slave_master: int32) → bool

Attempts to connect a slave_master to a specific port.

Parameters

selected_port (int32) – Desired port.
slave_master (int32) – Desired slave_master.

Returns

True if operation was successful (slave_master connected to a port), False otherwise.

Return type

bool

reset_to_default() → bool

Attempts to reset the device to default.

Returns: True if operation was successful (device reset to default), False otherwise.
Return type: bool

restart_device() → bool

Attempts to restart the device.

Returns: True if operation was successful (device restarted), False otherwise.
Return type: bool

set_dynamic(conf_file: str) → bool

Attempts to set the device as dynamic.

Parameters: conf_file (str) – Device's configuration file.
Returns: True if operation was successful(device set to dynamic), False otherwise.
Return type: bool

set_wakeup_line_status(line_select: int32, line_status: int32) → bool

Attempts to set the wakeup line status of a specific line to a specific status.

Parameters

line_select (int32) – Desired line.
line_status (int32) – desired status.

Returns

True if operation was successful (status set), False otherwise.

Return type

bool

cluster_name

The name of the cluster that is mapped to the channel.

Type: str

name

The channel name. This Property is Read Only.

Type: str