View source for XML-RPC Protocol Method: consolecommand

{{Update|text=This documentation was ported over from LJ's Server Manual with minimal modification. It may not match Dreamwidth's implementation of the method, and needs to be double checked against the DW code and updated as necessary.}}

The Dreamwidth server has a text-based shell-like administration console where less-often used commands can be entered.  There's a web interface to this shell online, and this is another gateway to that.

== Inputs ==

{{XML-RPC Auth Inputs}}

<strong>commands</strong>
<em>Array of scalars. Required.</em> Array of commands to send, with double quotes around any arguments with spaces, and double quotes escaped by backslashes, and backslashes escaped with backslashes. Optionally, you can send a listref instead of a string for this argument, in which case, we'll use your argument separation and not parse it ourselves.

== Example Request ==

<syntaxhighlight lang="xml">
<?xml version="1.0"?>
<methodCall>
  <methodName>LJ.XMLRPC.consolecommand</methodName>
  <params>
    <param>
      <value><struct>
        <member>
          <name>username</name>
          <value><string>test</string></value>
        </member>
        <member>
          <name>password</name>
          <value><string>test</string></value>
        </member>
        <member>
          <name>ver</name>
          <value><int>1</int></value>
        </member>
        <member>
          <name>commands</name>
          <value><array><data>
            <value><string>help print</string></value>
          </data></array></value>
        </member>
      </struct></value>
    </param>
  </params>
</methodCall>
</syntaxhighlight>

== Outputs ==

<strong>results</strong>
<em>Array of structs. Required.</em> One struct returned for each command run, that struct containing both the overall return value, and the line-by-line output of the command, with each line of output being tagged by type (think stdout vs. stderr, but with stdinfo also).  The web interface shows errors in red, normal output in black, and informational output in green.  Clients are encouraged to also, if possible. Each struct contains these keys:

:*<strong>success</strong> <em>Scalar. Required.</em> Return status of nth command.  0 or 1.
:*<strong>output</strong> <em>Array of arrays. Required.</em> This array holds a 2-item array for each line of a command's output. The items in the array are:
:** <em>Scalar. Required.</em> Type of output line.  Either "" (normal output), "error", or "info", something to be emphasized over normal output.
:** <em>Scalar. Required.</em> The text of that line.   

== Example Response ==

<syntaxhighlight lang="xml">
HTTP/1.1 200 OK
Connection: close
Content-length: 1189
Content-Type: text/xml
Date: Tue, 16 Jul 2002 22:59:33 GMT
Server: Apache/1.3.4 (Unix)

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
      <value><struct>
        <member>
          <name>results</name>
          <value><array><data>
            <value><struct>
              <member>
                <name>success</name>
                <value><int>1</int></value>
              </member>
              <member>
                <name>output</name>
                <value><array><data>
                  <value><array><data>
                    <value><string></string></value>
                    <value><string>print ...</string></value>
                  </data></array></value>
                  <value><array><data>
                    <value><string></string></value>
                    <value><string>  This is a debugging function.  Given an arbitrary number of</string></value>
                  </data></array></value>
                  <value><array><data>
                    <value><string></string></value>
                    <value><string>  meaningless arguments, it'll print each one back to you.  If an</string></value>
                  </data></array></value>
                  <value><array><data>
                    <value><string></string></value>
                    <value><string>  argument begins with a bang (!) then it'll be printed to the error</string></value>
                  </data></array></value>
                  <value><array><data>
                    <value><string></string></value>
                    <value><string>  stream instead.</string></value>
                  </data></array></value>
                </data></array></value>
              </member>
            </struct></value>
          </data></array></value>
        </member>
      </struct></value>
    </param>
  </params>
</methodResponse>
</syntaxhighlight>

[[Category: Development]]