proc_creating-a-shellhook-to-print-arguments.adoc

Creating a Shellhook to Print Arguments

Create a simple shellhook script that prints "Hello World!" when you run a remote execution job.

Prerequisite

• You have the webhooks and shellhooks plug-ins installed. For more information, see:

  • [installing-webhooks-plugin_{context}]

  • [installing-shellhooks-plugin_{context}]

Procedure

1. Modify the /var/lib/foreman-proxy/shellhooks/print_args script to print arguments to standard error output so you can see them in the {SmartProxy} logs:

   #!/bin/sh
   #
   # Prints all arguments to stderr
   #
   echo "$@" >&2

2. In the {ProjectWebUI}, navigate to Administer > Webhook > Webhooks.

3. Click Create new.

4. From the Subscribe to list, select Actions Remote Execution Run Host Job Succeeded.

5. Enter a Name for your webhook.

6. In the Target URL field, enter the URL of your {SmartProxyServer} followed by :{smartproxy_port}/shellhook/print_args:

   https://{smartproxy-example-com}:{smartproxy_port}/shellhook/print_args

   Note that shellhook in the URL is singular, unlike the shellhooks directory.

7. From the Template list, select Empty Payload.

8. On the Credentials tab, check {SmartProxy} Authorization.

9. On the Additional tab, enter the following text in the Optional HTTP headers field:

   {
       "X-Shellhook-Arg-1": "Hello",
       "X-Shellhook-Arg-2": "World!"
   }

10. Click Submit. You now have successfully created a shellhook that prints "Hello World!" to {SmartProxy} logs every time you a remote execution job succeeds.

Verification

1. Run a remote execution job on any host. You can use time as a command. For more information, see {ManagingHostsDocURL}executing-a-remote-job_managing-hosts[Executing a Remote Job] in {ManagingHostsDocTitle}.

2. Verify that the shellhook script was triggered and printed "Hello World!" to {SmartProxyServer} logs:

   # tail /var/log/foreman-proxy/proxy.log

   You should find the following lines at the end of the log:

   [I] Started POST /shellhook/print_args
   [I] Finished POST /shellhook/print_args with 200 (0.33 ms)
   [I] [3520] Started task /var/lib/foreman-proxy/shellhooks/print_args\ Hello\ World\!
   [W] [3520] Hello World!