Multiline Commands - Cisco MX700 Reference Manual

Cisco TelePresence MX700 and MX800

Introduction

Multiline commands

Multiline commands are commands that support larger
amounts of data as input than the single line commands.
Typical use for these commands is to allow for provi-
sioning of in-room control definitions, branding images
(base64 encoded), macros, welcome banners, and security
certificates.
To issue a multiline command, you start issuing it like
any other XAPI command. However, once you enter the
command, you have set the API into an input mode where
anything you issue on the API after this is treated as input
to that command, including line breaks. You now enter the
payload for this command in accordance to the input format
expected by this command
When done, finish with a line break("\n") and a separate line
containing just a period ending with a line break (".\n"). The
command will now be executed, and you will get a command
result with an OK or ERROR depending on the command
being executed successfully or not.
The commands that require multiline input format are marked
as such in the command descriptions in this guide.
The multiline commands are marked as multiline in
xCommand overview section in this guide.
D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.
About the API About the API xConfiguration
Example: Set up welcome banner text
xCommand SystemUnit SignInBanner Set
Hello!
This is the second line of text.
This is the third.
Thank you!
.
OK
*r SignInBannerSetResult (status=OK):
** end
xCommand
28
API Reference Guide
xStatus Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.