Xstatus Systemunit State Subsystem Application; Xstatus Systemunit Contactinfo; Xstatus Systemunit Contactname; Xstatus Systemunit Notifications Notification [N] Type - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Contents
Introduction

xStatus SystemUnit State Subsystem Application

Shows the status of the sub system application.
Initialized: The sub-system application is initialized.
Initializing: The sub-system application is initializing.
Value space of the result returned:
<Initialized/Initializing>
Example:
xStatus SystemUnit State Subsystem Application
*s SystemUnit State Subsystem Application: Initialized
** end

xStatus SystemUnit ContactInfo

Returns the system's active contact information. This is the address which is used to reach this
system.
Value space of the result returned:
<String>
Example:
xStatus SystemUnit ContactInfo
*s SystemUnit ContactInfo: "firstname.lastname@company.com"
** end

xStatus SystemUnit ContactName

Returns the system's active contact name. The result depends on which protocol, if any, the system
is registered on. Unlike Contact Info, Contact Name is not configurable and is automatically set by
the system.
Value space of the result returned:
<String>
Example:
Not registered to a protocol
xStatus SystemUnit ContactName: "192.0.2.0"
Example 2: Registered on SIP
xStatus SystemUnit ContactName: "1234@192.0.2.0"
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API
xConfiguration

xStatus SystemUnit Notifications Notification [n] Type

xStatus SystemUnit Notifications Notification [n] Text

197
xCommand
Lists the system notification types. Notifications are issued e.g. when a system is rebooted because
of a software upgrade, or when a factory reset is performed.
FactoryResetOK: This value is returned after a successful factory reset.
FactoryResetFailed: This value is returned after a failed factory reset attempt.
SoftwareUpgradeOK: This value is returned after a successful software upgrade.
SoftwareUpgradeFailed: This value is returned after a failed software upgrade attempt.
RebootRequired: This value is returned when a reboot is required.
Other: This value is returned for any other notifications.
All the notifications can be removed from the list by issuing the xCommand SystemUnit Notifications
RemoveAll command.
Value space of the result returned:
<FactoryResetOK, FactoryResetFailed, SoftwareUpgradeOK, SoftwareUpgradeFailed,
RebootRequired, Other>
Example:
xStatus SystemUnit Notifications Notification 1 Type
*s SystemUnit Notifications Notification 1 Type: SoftwareUpgradeOK
** end
Lists text related to important system notifications. Notifications are issued e.g. when a system was
rebooted because of a software upgrade, or when a factory reset has been performed.
All the notifications can be removed from the list by issuing the xCommand SystemUnit Notifications
RemoveAll command.
Value space of the result returned:
<String>
Example:
xStatus SystemUnit Notifications Notification 1 Text
*s SystemUnit Notifications Notification 1 Text: "OK"
** end
API Reference Guide
xStatus
xStatus
Appendices
Copyright © 2015 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents