susemanager-api

Scripts using the SUSE Manager API

These scripts all use the SUSE Manager API to do common tasks and extract information from any SUSE Manager instance.

I get asked about how to use the API quite frequently, so I decided to make a few working examples (based on scripts I wrote waaaay back in 2014 -- I'm getting old!) and share them with the world.

General usage instructions

The older scripts with the URL to the SUMA server hardcoded in the first lines were moved to the "classic" folder. Please change that before using.

All scripts now have standardized parameters for specifying the server name (-s), user (-u), password (-p) and URL (--url). If you just specify the server name, it'll assume the default URL always (https:///api/rpc).

By default the CA verification will be disabled, but you can force it with "--verify".

All scripts have a -h/--help parameter.

Most of the actions will require a regular SUMA user that's at least capable of reading information (Read-only user). The runscripts_sm script requires an admin user, as it is indeed creating/scheduling jobs.

These scripts are meant to make it easy to customize SUSE Multi-Linux Manager/Uyuni to your environment, and mainly so you can learn how to do it.

The complete SUSE Multi-Linux Manager API reference is available at: https://documentation.suse.com/suma/5.1/api/suse-manager/index.html

Currently available scripts

• add_to_group.py: adds a system to System Group
• apply_state.py: apply a named salt state to a system
• create_activationkey.py: create a new activation key
• create_group.py: create a new group
• create_user.py: create a new user
• check_activationkey.py: this will search for a named activation key and report if it exists or not.
• delete_system.py: delete a system profile
• delete_user.py: delete a user
• get_all_eventhistory.py: retrieves the entire event history for ALL systems. Requires a system ID.
• get_eventdetails.py: retrieves detailed information about one specific event in a system's history. Needs the system ID and the event ID.
• get_eventhistory.py: retrieves a list of all events for one system over the last 30 days. Requires a system ID.
• getresults_sm.py: this script will take a "jobs.csv" generated by runscripts_sm.py, query for all the results (including command output), and write them to a CSV.
• list_activationkeys.py: returns a list of all activation keys present on the system
• list_activesystems.py: returns a list of all ACTIVE systems (that have recently checked in with SUMA)
• list_groups.py: returns a list of all defined system groups
• list_systems.py: returns a list of all registered systems, including inactive ones
• list_channels.py: returns a list of all defined software channels, including child ones
• list_custominfo.py: returns all custominfo key/value pairs defined for a system. Requires a system ID.
• list_cvestatus.py: asks SUMA to return the patch status for a named CVE on all registered systems. Statuses can be PATCHED, AFFECTED_PATCH_APPLICABLE or NOT_AFFECTED.
• list_locked.py: returns a list of systems marked as "locked"
• list_needsreboot.py: returns a list of systems that currently need rebooting.
• list_config_channels.py: lists all configuration channels
• list_inactive_systems.py: lists systems that have been inactive for X days.
• list_orgs.py: lists all defined organizations
• list_users.py: lists all defined users
• lookup_systemid.py: looks up a hostname and returns the corresponding registered System ID.
• migrate_system.py: does a complete system migration from one service pack to the other (interactive)
• packagesinstalled90days.py: returns a list of all package actions that happened over the last 90 days, with status.
• rebootsystem.py: schedules a reboot for a system.
• runscript_sm.py: takes a list of hosts and a bash script, and schedules actions for every one of them. Use getresults_sm.py to fetch the results.
• updateallpackages.py: installs all pending updates for a system
• update_custominfo.py: sets a custominfo key/value pair for a specific system.

The migrate_system.py was inspired by the pull request at uyuni-project/uyuni-docs#3033, but I made it more interactive, with no hardcoded values.

• schedule_highstate.py: schedules a hightstate event for a system
• search_packages.py: search for packages in a specific channel
• search_patches.py: search for patches in the database
• system_details.py: fetch details for a specific system

curl scripts

By demand, I'm posting the curl-equivalent scripts. Note that you need the header.txt file present in the same directory, as they're reading from this file. I'm using the curl "cookie jar" feature to store/read the cookies/session ID tokens. You'll see a "cookies.txt" file being created after running any of these. The authentication token is removed at the end after the logout operation is performed on each script.

• curl_getSystemCurrencyScores.sh: does the same as list_allsystems.py script, which is to list all available systems, but with the corresponding patches/bugfixes counts/scores.
• curl_getId.sh: looks up a hostname and returns the corresponding System ID.
• curl_listsystems.sh: returns basic data from all available systems (name, id, last checkin, etc)