Hi
I promised I would jump in with a few pointers on this.
There is a few commands that have the "Multiline" functionality in the xAPI. Let's take the Sign-in banner as an example:
xCommand SystemUnit SignInBanner Set
This is a signinbanner
This is line 2
This is line 3
.
OK
*r SignInBannerSetResult (status=OK):
** end
First you type the command and hit <enter>. You are now in Multiline mode where a linebreak will just take more input. This makes sense for the SignInBanner since you might have a lot of text you want to put in with multiple lines of text.
When you are done typing you end the input with a . and hit <enter> to execute the command.
The same concept is when uploading certificates or macros via the xAPI. You can copy paste all the macro code in after you enter multiline mode and at the end, hit <enter> type . and hit <enter> to execute.
xCommand Macros Macro Save Name: Test Overwrite: True
const xapi = require('xapi');
//Enables H323
function enableH323() {
xapi.config.set('NetworkServices H323 Mode', 'On');
}
//Status listener for changes in the xStatus H323 Mode Status, if this changes to Disabled, flip back to enabled.
xapi.status.on('H323 Mode Status', value => {
if (value == "Disabled") enableH323();
});
enableH323();
.
OK
*r MacroSaveResult (status=OK):
** end
The same multiline functionality exists with the certificate uploads, and also for branding images (base64 encoded images) where you just paste the base64 value of the image into the xAPI running the correct command of course.
This is simple enough for one endpoint, but what if you want to utilize the XMLAPI to distribute the functionality across endpoints?
I figure you already know how to utilize the XMLAPI using a programming language of your preference (I have a working example using PHP and I can provide this if it is a demand for it. But here is what the payloads would look like:
$macroContent = file_get_contents("example_macro.js");
$configPayload = "
<XmlDoc>
<Configuration>
<Macros>
<Mode>On</Mode>
</Macros>
</Configuration>
</XmlDoc>";
$commandPayload = "
<XmlDoc>
<Command>
<Macros>
<Macro>
<Save>
<Name>example_macro</Name>
<Overwrite>False</Overwrite>
<body>".$macroContent."</body>
</Save>
<Activate>
<Name>example_macro</Name>
</Activate>
</Macro>
</Macros>
</Command>
</XmlDoc>";
The clue for setting multiline payloads via the XMLAPI is to set them into a <body></body> tag. The <body> tag is CASE SENSITIVE. If you use <Body> it will not work. Just a little heads up there.
The config payload (you need to separate the config and command payloads as they cannot be sent in the same payload) enables the Macro framework which is disabled by default (this is a logical first step). Then the command payload will upload the macro content using the multiline XMLAPI (you should extract the macro file contents into a variable as this looks better than writing the Macro as is into the script it self:S) and I also put in the command to make the uploaded macro active so you wont have to enable it manually, then it would all be kind of pointless...
You should also set a timer after activating the macro framework using the config payload (I figured 6 seconds was fine just to be sure) before uploading the macro and activating it with the command payload.
I hope this was somewhat helpful. Let me know if you have any questions.
/Magnus
