TweetFollow Us on Twitter

MacEnterprise: Scripting Opportunities for System Administrators, Part One

Volume Number: 25
Issue Number: 06
Column Tag: MacEnterprise

MacEnterprise: Scripting Opportunities for System Administrators, Part One

When, where, why, and how you should run administrative scripts

By Greg Neagle, MacEnterprise.org

Introduction

In previous MacTech columns, I have sometimes offered up a script or two as part of a solution to a particular problem. Even if the script I presented is a perfect fit for your environment, you might still have had trouble making effective use of it in your organization, because you did not know how to make it run at the right time or in the correct context to get the job done.

This month, we'll begin a look at some of the many mechanisms available to run scripts (and other processes). Each mechanism has different uses and is suited for a unique set of tasks. Depending on what you need to accomplish, you should select the appropriate mechanism.

Why?

The first question you should ask is "Why do I want to run this script? What task do I want to accomplish?" Some of the common administrative categories that might lend themselves to scripting are:

System configuration - initial setup of the OS, networking, user accounts, etc.

System management - ongoing management of system settings; enforcing system-wide policies

User settings/preferences - configuring applications; setting up useful default preferences, enforcing user-level policies

Administrator tools - tools to make tedious or difficult tasks easier or more consistent

Hacks/fixes/workarounds - scripts to "fix" or work around problems with the OS or applications (or users!)

When?

Once you know why you are running the script, or what you want to accomplish with the script, you can consider when it should run. Some of the possibilities:

On demand - only when invoked by an admin or user

At startup

Repeating (daily/weekly/monthly, or other intervals like hourly, every 15 minutes, etc)

When a user logs in

When a user logs out

Let's look at some logical pairings of "Why?" and "When?":

Utility scripts or administrative tools that are to be run only on demand are the easiest to handle. Simply put them in a directory somewhere and run them manually as needed, or run them remotely using Apple Remote Desktop or SSH.

If your script is doing system configuration tasks like binding a machine to Active Directory or creating local users, it should almost certainly run at startup. System management tasks might run at startup, on a repeating schedule, or both.

Tasks that affect user settings or preferences should probably run at user login, or if it's a cleanup task, perhaps at user logout.

Hacks/fixes/workarounds can vary when it is appropriate to run them: they may need to run on demand; they may need to run at login to make a change to a user's environment; they may need to run at startup to clear out stale cached data.

How?

How can you run your script when you want? Let's look at some of the available mechanisms.

Running a script at startup

There are several ways to run scripts at startup, but the two most commonly used on Mac OS X are StartupItems and launchd items. Both Startup Items and launchd's LaunchDaemons run in the root context.

StartupItems

Startup items have been used on Mac OS X for a long time, and continue to work in OS X 10.5 Leopard. Administrator-provided Startup items should be placed in /Library/StartupItems. Since Apple is phasing out StartupItems, we won't spend a lot of time on these. A Startup Item consists of a directory containing an executable (typically a shell script) and a StartupParameters.plist file. Both the executable/shell script and the StartupParameters.plist have a very specific format. The startup item directory may optionally contain other items - for example, a Resources subdirectory. Apple has some good documentation on creating StartupItems here:

http://developer.apple.com/documentation/MacOSX/Conceptual/BPSystemStartup/Articles/StartupItems.html

launchd items

launchd was introduced with Mac OS X 10.4 Tiger. It was intended to replace almost every other way of launching processes, though in practice it has not yet accomplished that. Still, launchd is very capable, and Apple continues to enhance it. Launchd items are simpler to setup than StartupItems, as they generally require only a single additional file other than the actual script or executable. Administrator-provided launchd items that run a script at startup should go in /Library/LaunchDaemons.

Launchd has been covered extensively in MacTech as well as many other places, so I won't go into great depth. But let's do a quick example. Let's say we have a configuration script that we want to run at startup. It is located at /Library/Management/configuration.sh, and is marked as executable. It looks like this:

#!/bin/sh
logger -t configuration "Hello from the config script!"

This script simply writes a message to the system log. You can test it manually:

root# /Library/Management/configuration.sh
root# tail /var/log/system.log
<snip>
Apr 21 12:31:05 arcus configuration[8400]: Hello from the config script!

To get it to run at startup, you'd need a property list at /Library/LaunchDaemons/com.mactech.demo.plist that looks something like this:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
   <key>Label</key>
   <string>com.mactech.demo</string>
   <key>ProgramArguments</key>
   <array>
      <string>/Library/Management/configuration.sh</string>
   </array>
   <key>RunAtLoad</key>
   <true/>
   <key>OnDemand</key>
   <true/>
</dict>
</plist>

This property list should have owner: root, group: wheel, and mode: 0644. Some explanation of the included keys:

Label is a string used by launchd to identify the job. The name of the plist file is usually the same as this label plus ".plist".

ProgramArguments is simply the full path to the executable script.

RunAtLoad is set to true so that launchd will run the job when it loads it, which is normally at startup.

OnDemand is set to true so that launchd won't attempt to restart the script once it exits - in other words, this process/script is not meant to run continuously.

We could test the launchd job by rebooting and then looking at the system log for our message, but rebooting can take a while, and if there's a problem, the fix/retest cycle is tedious. So let's do a quicker test:

root# launchctl load /Library/LaunchDaemons/com.mactech.demo.plist
root# tail /var/log/system.log
<snip>
Apr 21 12:31:05 arcus configuration[8400]: Hello from the config script!
Apr 21 12:37:13 arcus configuration[9073]: Hello from the config script!

At the end of the system log, you should see the message from the configuration script.

If you have problems, unload the job:

root# launchctl unload /Library/LaunchDaemons/com.mactech.demo.plist

Make your changes to the plist, and try loading the job again. Once the job is working, you should be able to reboot, and see the message in the system log during the startup process.

Apple documentation on creating a launchd item is available here:

http://developer.apple.com/documentation/MacOSX/Conceptual/BPSystemStartup/Articles/LaunchOnDemandDaemons.html

Repeating scripts

Some scripts are best run on repeating intervals. For example, you have a script that scans the startup disk for all installed fonts and then uploads that list of fonts to a database somewhere so you can monitor for license compliance. You should run that script periodically: maybe daily, maybe weekly, maybe monthlyit's up to your organization. There are several ways to do this.

One of the easiest ways is to piggy-back off an existing facility for running repeating scripts: the periodic command. By default, periodic is used to run scripts on a daily, weekly or monthly basis. It runs all the scripts it finds in certain directories:

/etc/periodic/daily/ - these are run every day

/etc/periodic/weekly/ - these are run once a week

/etc/periodic/monthly/ - these are run once a month

To get periodic to run your scripts, mark them as executable and put them in the appropriate directory. You can control the order in which the scripts run by naming them appropriately. The convention used is to start the script name with a three-digit number; the scripts are then run in numeric order:

root# ls -1 /etc/periodic/daily
100.clean-logs
110.clean-tmps
130.clean-msgs
430.status-rwho
500.daily
599.randomSleep
600.updateMachineName
700.updateHostInfo
900.autoradmind

There are some issues to be aware of, however. The first is exactly when these scripts will run. This is controlled by launchd in the following files in /System/Library/LaunchDaemons:

com.apple.periodic-daily.plist
com.apple.periodic-monthly.plist
com.apple.periodic-weekly.plist

Looking at com.apple.periodic-daily.plist:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
   <key>Label</key>
   <string>com.apple.periodic-daily</string>
   <key>ProgramArguments</key>
   <array>
      <string>/usr/sbin/periodic</string>
      <string>daily</string>
   </array>
   <key>LowPriorityIO</key>
   <true/>
   <key>Nice</key>
   <integer>1</integer>
   <key>StartCalendarInterval</key>
   <dict>
      <key>Hour</key>
      <integer>3</integer>
      <key>Minute</key>
      <integer>15</integer>
   </dict>
</dict>
</plist>

The StartCalendarInterval key tells us it will run each day at 3:15 AM local time. That time might not be a good one for your environment. Consider a few scenarios:

Desktop machines: if the desktops in your organization are left on 24/7, then the script will run shortly after 3:15 AM each day. If instead, they are asleep at 3:15 AM, they'll run shortly after they are woken up each day. If they are powered off at 3:15 AM, the scripts won't run at all. Launchd will reschedule jobs that were scheduled to run when the machine was asleep, but will not reschedule jobs that were scheduled to run when the machine was powered off.

Laptop machines: all of the same complications as with desktops, with the additional problem that if they get taken home at night or over the weekend, and run these jobs at 3:15 AM (or when woken up), and your scripts require access to network services or resources available only when the machine is connected to your organization's network, they may fail, or at the very least, fail to do anything useful.

Therefore, you might consider changing the time these jobs run to a time during the day when it's more likely the machine is on, awake, and on your network.

Another possible approach that does not require modifying Apple's provided launchd items is to run a script at startup that checks for overdue periodic jobs and runs them. Such a script is described (and available) here:

http://managingosx.wordpress.com/2008/06/18/launchd-vs-periodic/

Repeating launchd jobs

Looking at the property list for com.apple.periodic-daily.plist suggests another method for running scripts on a repeating basis: avoiding the periodic middleman and using launchd directly. Using our com.mactech.demo example as before, we can run a script at startup and once a day with a LaunchDaemon plist like this:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
   <key>Label</key>
   <string>com.mactech.demo</string>
   <key>ProgramArguments</key>
   <array>
      <string>/Library/Management/configuration.sh</string>
   </array>
   <key>RunAtLoad</key>
   <true/>
   <key>OnDemand</key>
   <true/>
   <key>StartCalendarInterval</key>
   <dict>
      <key>Hour</key>
      <integer>12</integer>
      <key>Minute</key>
      <integer>15</integer>
   </dict>
</dict>
</plist>

We've added a StartCalendarInterval to the previous version of the property list that tells launchd to run the job each day at 12:15, when many of our staff will be at lunch. If we didn't want it to run at startup as well, we could remove the RunAtLoad key, or set it to false.

Good old cron

One last method to mention: the classic UNIX cron is still available in OS X, and can still be used to run repeating jobs. Type man cron at a command prompt for details. You'll probably want to create a crontab at /etc/crontab . A big disadvantage of using cron is that it's hard to manage different versions of the crontab files. For example, if you have a set of machines that need repeating jobs A and B, another set that needs repeating jobs B and C, and yet another set that needs repeating jobs A, B and C, you'll need to manage three different versions of the crontab as well as the scripts that do the actual jobs. If you use periodic or launchd, you don't have to deal with the monolithic crontab file, as the scheduling info for each job lives in a separate file (or in the case of periodic, is not needed).

To be continued...

We covered quite a bit this month. We looked at running scripts at startup and on a repeating schedule. In the future, we'll look at running scripts as part of the login and logout process, both with root privileges, and as the user logging-in. While you might guess that launchd might be useful here, we'll also look at login/logout hooks and login items. We'll also consider the special case of scripts that should run only once, either at startup or login. Finally, we'll look at some methods to simplify implementing additional scripts once you have a few working. See you next time!


Greg Neagle is a member of the steering committee of the Mac OS X Enterprise Project (macenterprise.org) and is a senior systems engineer at a large animation studio. Greg has been working with the Mac since 1984, and with OS X since its release. He can be reached at gregneagle@mac.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

ExpanDrive 5.4.6 - $49.99
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Apple Pages 6.1.1 - Apple's word pr...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices, and... Read more
Apple Numbers 4.1.1 - Apple's sprea...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
Apple Keynote 7.1.1 - Apple's prese...
Easily create gorgeous presentations with the all-new Keynote, featuring powerful yet easy-to-use tools and dazzling effects that will make you a very hard act to follow. The Theme Chooser lets you... Read more
Espresso 5 - Powerful HTML, XML, CSS, an...
Espresso is back. For people who make delightful, innovative, and fast websites -- in an app to match. Espresso helps you write, code, design, build, and publish with flair and efficiency.... Read more
Vitamin-R 2.47 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
Dash 4.0.3 - Instant search and offline...
Dash is an API documentation browser and code snippet manager. Dash helps you store snippets of code, as well as instantly search and browse documentation for almost any API you might use (for a full... Read more
Posterino 3.3.6 - Create posters, collag...
Posterino offers enhanced customization and flexibility including a variety of new, stylish templates featuring grids of identical or odd-sized image boxes. You can customize the size and shape of... Read more
Together 3.8.3 - Store and organize all...
Together helps you organize your Mac, giving you the ability to store, edit and preview your files in a single clean, uncluttered interface. Features Smart storage. With simple drag-and-drop... Read more
iClock Pro 3.4.9 - Customize your menuba...
iClock Pro is a menu bar replacement clock for Apple's default clock. iClock Pro is an update, total rewrite and improvement to the popular iClock. Have the day, date and time in different fonts and... Read more

Latest Forum Discussions

See All

Minimalist puzzle game, Cuts, free on iO...
If you're looking for a gorgeous puzzle experience on iOS devices, developer Gamebra.in's aesthetically interesting puzzler, Cuts, is discounted to free on the iOS App Store right now. [Read more] | Read more »
Anime tactical RPG, War of Crown, comes...
If you're looking for another tactical RPG fix to go alongside your Fire Emblem Heroes campaigns check out Gamevil's newest, anime-inspired tactics RPG, War of Crown, which comes out tomorrow. [Read more] | Read more »
Fantasy MMORPG MU Origin adds new modes,...
MU Origin, Webzen’s highly popular fantasy MMORPG is getting ready to shake things up for the second time this year, as a new update makes its way to the Google Play and App Store from today. Introducing new systems, modes, and events, the land of... | Read more »
Blizzard is looking to hire a mobile dev...
A new thread on the popular video game rumor forum, NeoGAF, uncovered an interesting job listing over at Blizzard Entertainment. It appears the studio behindStarCraft, World of WarCraft, Hearthstone,andOverwatch is looking to bring on a new hire... | Read more »
Legend of Zelda meets Cooking Mama in ne...
Dungeon Chef is what happens when you mix the RPG elements (and style) of a Legend of Zelda game, with cooking elements. Although, now that The Legend of Zelda: Breath of the Wild also has cookingelements, so maybe the gameplay is not so novel.... | Read more »
ChordFlow (Music)
ChordFlow 1.0.0 Device: iOS Universal Category: Music Price: $6.99, Version: 1.0.0 (iTunes) Description: ChordFlow is a chord sequencer with a unique 4-track polyphonic arpeggiator, extensive chord library, MIDI out and Ableton Link... | Read more »
The Walking Dead: A New Frontier is out...
The newest season of Telltale Games'The Walking Dead is well underway. After the release of the third episode, "Above the Law" about a month ago, episode four, "Thicker Than Water" is hot and ready for more zombies and gut-wrenching emotional... | Read more »
Best games we played this week
Another week, another new wave of mobile games do dive into. We've dug through the list of apps that came out this week to tell you which apps are worth your sweet time. And while there weren't too many games this week, there were some big ones.... | Read more »
Vignettes (Games)
Vignettes 1.0.1 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.1 (iTunes) Description: Vignettes is a casual but unique exploration game without text or characters, where objects shapeshift as you spin them around... | Read more »
Get Me Outta Here is an 80s retro shoote...
Are you ready to fight some aliens? Because Crescent Moon Games has released the retro shooter Get Me Outta Here on iOS devices today. [Read more] | Read more »

Price Scanner via MacPrices.net

HyperX Ships Pulsefire FPS Gaming Mouse, Winn...
Your reporter is a longtime fan of gaming mice for general purpose coomnputing use, finding them typically superior in comfort and performance. HyperX, a division of Kingston Technology Company, Inc... Read more
Penske Truck Leasing Unveils “Penske Fleet” M...
Penske Truck Leasing has introduced a free mobile app called “Penske Fleet” to benefit its full-service truck leasing and contract maintenance customers. The mobile app enables Penske’s customers to... Read more
DEVONthink To Go 2.1.3 For iOS Adds New Declu...
DEVONtechnologies has updated DEVONthink To Go, its iOS companion to DEVONthink for Mac. Enhancements and bug fixes in Version 2.1.3 include DEVONtechnologies’ new decluttering service for clipping... Read more
Use Apple’s Education discount to save up to...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: -... Read more
Apple refurbished Apple Watches available sta...
Apple is now offering Certified Refurbished Series 1 and Series 2 Apple Watches for 14-16% off MSRP, starting at $229. An Apple one-year warranty is included with each watch. Shipping is free: Series... Read more
15-inch Touch Bar MacBook Pros, Apple refurbi...
Apple is offering Certified Refurbished 2016 15″ Touch Bar MacBook Pros for $360 to $420 off original MSRP. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2.6GHz... Read more
13-inch MacBook Airs on sale for up to $150 o...
Overstock.com has 13″ MacBook Airs on sale for up to $150 off MSRP including free shipping: - 13″ 1.6GHz/128GB MacBook Air (sku MMGF2LL/A): $869.99 $130 off MSRP - 13″ 1.6GHz/256GB MacBook Air (sku... Read more
15-inch Touch Bar MacBook Pros on sale for $1...
B&H Photo has the new 2016 15″ Apple Touch Bar MacBook Pros in stock today and on sale for up to $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.7GHz Touch Bar... Read more
15-inch 2.7GHz Touch Bar MacBook Pros on sale...
Amazon has 2016 15″ 2.7GHz Apple Touch Bar MacBook Pros in stock today and on sale for $150-$200 off MSRP. Shipping is free: - 15″ 2.7GHz Touch Bar MacBook Pro Space Gray (sku MLH42LL/A): $2599 $200... Read more
Apple now offering Certified Refurbished 13-i...
Apple is now offering Certified Refurbished 2016 13″ Touch Bar MacBook Pros for $270-$300 off original MSRP. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.9GHz... Read more

Jobs Board

*Apple* Engineering Specialist - CSRA (Unite...
Apple Engineering Specialist All times are in Eastern Daylight Time Requisition ID Job Locations US DC Washington DC Posted Date Category Engineering Sciences Read more
*Apple* Mac Computer Technician - GeekHampto...
…complex computer issues over the phone and in person? GeekHampton, Long Island's Apple Premium Service Provider, is looking for you! Come work with our crew Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 56881986 Middletown, NY, New York, United States Posted: Apr. 17, 2017 Weekly Hours: 40.00 **Job Summary** As an Apple Read more
*Apple* Mobile Master - Best Buy (United Sta...
**489879BR** **Job Title:** Apple Mobile Master **Location Number:** 000402-Utica-Store **Job Description:** **What does a Best Buy Apple Mobile Master do?** At Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.