The autoscript utilities automatically transfer a shell script from shore to the SIAM primary node during a telemetry connection. A component on the node (runAutoscript) automatically execute the script there, and returns the script output on a subsequent connection.

These utilities are very useful in cases where the telemetry link is intermittent and unpredictable, making it difficult to sustain a connection long enough to perform maintenance or troubleshooting operations.

To automatically transfer and execute a script, follow these steps:

• Write the script
  • autoscripts must be implemented as 'bash' shell scripts
  • autoscript does not validate the script, so it is critical to adequately test the script before deploying it.
  • Note that the last line of an autoscript must be the following special comment:
    # AUTOSCRIPT EOF
    The '#' character must appear in the first column.
• Set up the transfer on the SIAM portal.
  • Copy the script to the portal
  • Log on to the portal and become root user
  • Set script permissions 775 (rwxrwxrx)
  • As root, copy the script to the autoscript directory with the name 'autoscript':
    cp myScript $SIAM_HOME/autoScript/pending/autoscript
  • Note the following
    • Execution of the autoscript is NOT synchronized with telemetry retrieval by the portal utility
    • Only one autoscript is recognized and executed in surface node's "pending" directory
    • Execution of an autoscript is one-time only
    • ssh MUST be configured such that user 'ops' is not prompted for a password when transferring files via 'scp' to and from the SIAM primary node
  a
• Get the results
  • Each time the node makes a connection to the portal, pending scripts are transferred to the node,
    and results from previous scripts are returned and emailed to users. To receive results from autoscript, edit
    /etc/ppp/ip-up.local
    and find the call to manageAutoscript; add your email address to the list of recipients.
  • autoscript results will be sent by email when the script has completed execution

The scripts that implement autoscript include:

• manageAutoscript - Executes on the portal host; invoked by /etc/ppp/ip-up.local. Automatically transfers a pending autoscript from shore to SIAM primary node. Retrieves results of previous autoscript from SiAM primary node to shore and emails it to users.
• runAutoscript - Executes on the SIAM primary node. Automatically executes autoscript transferred from shore, captures script output (stdout, stderr).

Options

Example output:

					none