Device

The DEVICE Instance Tag is case sensitive and must be in capital letters. It is used to send Device Services instructions or Device Attributes and Commands.

Device Services

The Following table summarizes DEVICE Service Codes. Due to the nature of the service being requested they do not require specific commands (get, set, etc)

Some service commands are specific to the connected device, such as 'reboot'. Other Service commands are design file specific, such as saving or recalling a Preset.

The TTP string is structured in the following order:

Instance_Tag Service [Value]

 

Description Service Value
Manual Failover manualFailover unitNumber
Reboot Device you are connected to via SSH or Telnet reboot  
Reset Device you are connected to via SSH or Telnet deleteConfigData  
Reboot Expander class device rebootERD ["hostname", "2nd hostname", "etc"]
Recall a Preset recallPreset Preset ID (Integer)
Recall a Preset and provide device for failures recallPresetShowFailures Preset ID (Integer)
Recall a preset by preset name recallPresetByName Preset name (a string)
Save a Preset savePreset Preset ID (Integer)
Save a preset by preset name savePresetByName Preset name (a string)
Start System Audio startAudio  
Stop System Audio stopAudio  
Start Partition Audio startPartitionAudio Partition ID (integer)
Stop Partition Audio stopPartitionAudio Partition ID (integer)

 

Examples:

To reboot the device you are connected to:

Instance Tag Service
DEVICE reboot

Result: DEVICE reboot

 

To start Audio on a device:

Instance Tag Service
DEVICE startAudio

Result: DEVICE startAudio

 

To reboot multiple expander devices.

Instance Tag Service
DEVICE rebootERD ["EX-OUT-0000", "EX-IN-0001", EX-AEC-0001]

Result if all expanders are discoverable and accept the reboot command: +OK "failedDevices":[ ]

Result if all but the EX-IN expander are discoverable and accept the reboot command: +OK "failedDevices":["EX-IN-0001"]

 

Device manual Failover

 

Instance Tag

Service

index

DEVICE

manualFailover

unitNumber

Result: DEVICE manualFailover 1

 

Device Attributes and Commands

Additionally there are a number of DEVICE Instance Tag command Attributes. These would reference the device that has the current active Serial, SSH or TELNET session.

 

Please refer to the TTP Overview section for more details on the controlling Tesira devices using the TTP protocol.

Each element of the command instruction is delimited by one or more spaces. The commands are case sensitive and upper and lower case characters are used.

The TTP string to adjust a DSP object attribute is structured in the following order:

Instance_Tag Command Attribute [Index] [Value] LF

 

Attribute Description

Attribute Code

Command

Indexes

Value Range

Active Faults activeFaultList get    
AVB Peer Delay Threshold avbPDelayThreshold get
set
increment
decrement
  0 - 2,147,483,647
Discovered Servers discoveredServers get    
DNS Config dnsConfig get/set    
DNS Status dnsStatus get    
Remote Device AVB Peer Delay Threshold ERDavbPDelayThreshold get
set
increment
decrement
hostname 0 - 2,147,483,647
Enable RSTP on a device
rstpEnabled
 
get
set
toggle
   
Host Name hostname get/set   *Host Name modification will not be available unless the device is in an un-configured state. Attempting to modify the Host Name via this command will result in an error message if the system is currently configured. A reset of the device is required to make changes to the Host Name first (DEVICE deleteConfigData command or a Reset Device via Device Maintenance). In the scenario where a system is configured and is Reset to change the Host Name, the Equipment Table will need to be re-opened and updated to reflect the new details, and the configuration re-sent to the system.
Resolver Hosts Table hostTable get/set    
Network Interface Config ipConfig get/set interface name control
Network Interface Status ipStatus get interface name control
mDNS Enabled mDNSEnabled get/set
toggle
  false true
Network Status networkStatus get    
Serial Number serialNumber get    
Telnet telnetDisabled get / set   false true

SSH

sshDisabled get / set   false true
Firmware Version version get    

 

 

Instance Tag Command Attribute Code
DEVICE get serialNumber

Example
DEVICE get serialNumber
 
+OK "value":"01842224"

Example
DEVICE get networkStatus
 
+OK "value":{"schemaVersion":2 "hostname":"TesiraServer91" "defaultGatewayStatus":"0.0.0.0" "networkInterfaceStatusWithName":[{"interfaceId":"control" "networkInterfaceStatus":{"macAddress":"00:90:5e:13:3b:27" "linkStatus":LINK_1_GB "addressSource":STATIC "ip":"10.30.150.62" "netmask":"255.255.0.0" "dhcpLeaseObtainedDate":"" "dhcpLeaseExpiresDate":"" "gateway":"0.0.0.0"}}] "dnsStatus":{"primaryDNSServer":"0.0.0.0" "secondaryDNSServer":"0.0.0.0" "domainName":""} "mDNSEnabled":true" telnetDisabled":false}

 

ipConfig commands

The ipConfig command can set the DHCP state, IP address, Subnet mask and Gateway on a Tesira Server, Server IO and TesiraFORTÉ device. Only values that need to be changed are required to be specified.

 

To get the IP configuration of a device:

Instance Tag Command Attribute Code Index
DEVICE get ipConfig control

Example
DEVICE get ipConfig control
+OK "value":{"autoIPEnabled":true "ip":"" "netmask":"" "gateway":""}

 

To set a device to not use DHCP and with an IP address of 192.168.1.210, a subnet of 255.255.255.0 and no gateway:

Example
DEVICE set ipConfig control {"autoIPEnabled":false "ip":"192.168.1.210" "netmask":"255.255.255.0" "gateway":"0.0.0.0"}

 

To set a device that is using a fixed IP address to use DHCP

Example
DEVICE set ipConfig control {"autoIPEnabled":true }

 

To change a device IP address to a new address in the same subnet (this example moves a device from 192.168.1.210 to 192.168.1.110) :

Example
DEVICE set ipConfig control { "ip":"192.168.1.110" }