Skip to main content

My favorite GAM commands - well a few of them at least!

Where would be without GAM? Paying for expensive syncing tools or doing tedious manual tasks in the admin console. GAM can automate most things you might want to do in G Suite. So these are a few of my favourite commands - one I use either as part of a batch file - or just standalone. There are loads more - but these are ones that are used daily.


Create a spreadsheet of all your domains classes - gam print courses todrive

Create a spreadsheet of a teacher's classes: gam print courses teacher todrive

Bulk create classes:
gam csv classes.csv gam create course alias ~alias name ~alias section ~subject teacher ~teacher status ACTIVE

where classes.csv is a list of classes you want to make.

Add teachers:
gam csv teachers.csv gam course ~alias add teacher ~teacher

Add students:
gam csv students.csv gam course ~alias add teacher ~student

Sync Students (in this example to a group - but could be an ou/csv file)
gam csv groups.csv gam course ~groupmail sync students group ~groupemail

Invite guardians
gam csv guardians.csv gam create guardianinvite ~”Primary Email” ~Email 

where Primary Email = guardians email Email = students G Suite Account

Remove guardian
gam delete guardian guardianemail studentemail


To move chromebooks to specific OU and asset tag etc

gam csv devices.csv gam update cros ~deviceid user ~email notes ~Name ou ~ou

email = users email note = users name ou = ou to pop the device into

ou syntax is like /Chrome Devices/Assigned to specific users/2014 Devices as an e.g. Put stuff in double quotes if in the actual gam command.

List all ChromeOS devices to drive
gam print cros basic todrive

Disable/enable device
gam cros deviceid action disable/reenable
This is way faster than doing this in the management console!


Bulk add users to a group
gam csv users.csv gam update group add member ~email

Change permissions on a group
gam csv groups.csv gam update group ~groupmail who_can_post_message all_managers_can_post

So this one will read a list of groups in groups.csv - where there is a header groupmail and in that column, there are group email addresses. This will restrict them to managers and owners only posting.


Bulk make users:
gam csv users.csv gam create user ~email firstname ~first lastname ~last password ~password changepassword on org “/Students/2017 Students”

So this one makes users, puts them in the specified OU and forces password change at next login.


Delete a specific message for a list of users inboxes:
gam csv mail.csv gam user ~mail delete messages query rfc822msgid:MESSAGEIDHERE doit

mail.csv contains a list of email addresses you want to target. You will need the message id - you can get this from the mail reports in the admin console or vault.

Bulk command options

The simplest way to run bulk commands it "gam csv yourfile.csv gam commandyouwanttorun ....". You reference the headers in the csv file using the "~" symbol - see e.g's above.
The other option is to use PowerShell. I find this slower - but in some cases more reliable - particularly for the gam sync commands. An example would be:
$list = Import-Csv C:\GAM\groups.csv
foreach ($entry in $list)
    .\gam.exe course $($ sync students group $($entry.groupmail)


This does the same as gam csv groups.csv gam course ~groupmail sync students group ~groupemail however, works more reliably for me.

One of the nice things about GAM is that you can string commands together and run them on a schedule to keep stuff up to date. It also has the advantage is that you are authorising the app to run on your machine - and it's your project - you are not giving any power to any third party. Good for privacy.


Popular posts from this blog

Delete a specific email using GAM

If a user send an inappropriate email to a loads of people or get stung by some sort of email exploit you can quickly delete the email from all of the recipients using a GAM command. Step 1 - get the email header Go into Google Vault and search for the offending user or someone known to have got the message. Click show details and grab the email ID. This will be a long string of characters followed by Step 2 - find out who has the email Go into Google Vault and find the original message sent by the offending user. Look at the details to see who got it. Copy the list and dump it into a spreadsheet. Clean up to just a list of emails with a column header 'mail'. Save as a csv file. Step 3 - delete messages with GAM Put your CSV file in your GAM folder - this e.g. assumes its called mail.csv Run: gam csv mail.csv gam user ~mail delete messages query rfc822msgid: MESSAGEIDHERE doit The alternative nuke option is: gam all users delete messages query rf

How to provision Google Classroom using GAM and sync to Capita SIMS

This is a guide (or documentation for my own use!) to the provisioning of Google Classrooms across a large domain and how to achieve ongoing sync of student members. The advantages of doing this are: Teachers don't have to do anything - all their classes are just there. You can add multiple teachers to classrooms. No inviting a secondary teacher. Students have all their classes at the start of the term. Students are automatically in the correct classes. Classes have totally consistent names. You can do it for FREE - however, there are paid for options if you don't want to go the DIY approach. The following requires you to have the student, staff and optionally, guardian emails on SIMS. Step 1 - Setup up GAM - you need this to do command line processing on your domain. It's a very powerful tool to do batch commands. Step 2 - Export a list of current Classrooms and archive any you don't want. I'd recommend this as it means users will only see the ones