Technical References

D14 641.11 Codec C90 API Reference Guide TC6.2, JULY 2013. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. 122
Cisco TelePresence System Codec C90 API Reference Guide
xCommand SystemUnit FactoryReset
Reset the codec to factory default settings. The call logs are deleted and all system parameters are
reset to default values. All files that have been uploaded to the codec are deleted. The Release key
and Option key are not affected.
As a default the system restarts after the factory reset, but other behavior can be forced by
selecting a different TrailingAction.
TrailingAction: Select Shutdown or NoAction to override the default behavior (Restart).
Requires user role: ADMIN
Parameters:
Confirm(r): <Yes>
TrailingAction: <NoAction/Restart/Shutdown>
Example:
xCommand SystemUnit FactoryReset Confirm: Yes
*r FactoryResetConfirmResult (status=OK):
** end
xCommand SystemUnit SoftwareUpgrade
Initiate a software upgrade by fetching the software on a given URL. If the server requires username
and password these parameters must be included.
Requires user role: ADMIN
Parameters:
URL(r): <S: 0, 255>
UserName: <S: 0, 255>
Password: <S: 0, 255>
Example:
xCommand SystemUnit SoftwareUpgrade URL: "ftp://<ftp _ server _ ip _
address>/s52000tc4 _ 0 _ 0.pkg" UserName: testDownload Password: 1234
*r SystemUnitSoftwareUpgradeResult (status=OK):
** end
xCommand SystemUnit ConfigurationProfile Change
Select a previously saved configuration profile. NOTE: Requires a restart of the codec.
Requires user role: ADMIN
Parameters:
Name(r): <S: 0, 255>
Example:
xCommand SystemUnit ConfigurationProfile Change Name: "My _
ConfigurationProfile _ 1"
*r ConfigurationProfileChangeResult (status=OK):
Warning: New configuration profile will be active after next boot.
** end
xCommand SystemUnit ConfigurationProfile Remove
Delete a configuration profile that has been stored in the system.
Requires user role: ADMIN
Parameters:
Name(r): <S: 0, 255>
Example:
xCommand SystemUnit ConfigurationProfile Remove Name: "My _
ConfigurationProfile _ 1"
*r ConfigurationProfileRemoveResult (status=OK):
** end
xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs
Save the current system settings into a configuration profile. Assign a name to the new profile. The
name is the unique identifier of the profile.
Requires user role: ADMIN
Parameters:
Name(r): <S: 0, 255>
Example:
xCommand SystemUnit ConfigurationProfile SaveCurrentConfigurationAs Name:
"My _ ConfigurationProfile _ 1"
*r ConfigurationProfileSaveCurrentConfigurationResult (status=OK):
** end
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand