7.1 Important Scripts and Tools

There are two important groups of SMT commands: The smt command with its sub-commands is used for managing the mirroring of updates, registration of clients, and reporting. The rcsmt script is used for starting, stopping, restarting SMT services, and for checking their status.

7.1.1 SMT JobQueue

Since SUSE Linux Enterprise version 11, there is a new SMT service called SMT JobQueue. It is a system to delegate jobs to the registered clients.

To enable JobQueue, the smt-client package needs to be installed on the SMT client. The client then pulls jobs from the server via a cron job (every 3 hours by default). The list of jobs is maintained on the server. Jobs are not pushed directly to the clients and processed immediately, but the client asks for them. Therefore, a delay of several hours may occur.

Every job can have its parent job, which sets a dependency. The child job only runs after the parent job successfully finished. Job timing is also possible: a job can have a start time and an expiration time to define its earliest execution time or the time the job will expire. A job may also be persistent. It is run repeatedly with a delay. For example, a patch status job is a persistent job that runs once a day. For each client, a patch status job is automatically generated after it registers successfully against an SMT 11 server. The patchstatus information can be queried with the smt-client command. For the already registered clients, you can add the patchstatus jobs manually with the smt-job command.

You can manipulate, list, create or delete the jobs. For this reason, the command line tool smt-job was introduced. For more details on smt-job, see smt-job.

NOTE: Overriding the Automatic Creation of Patch Status Job

When creating a software push or an update job, normally a non-persistent patch status job will be added automatically with the parent id set to the id of the new job. To disable this behavior, use the --no-autopatchstatus option.

SMT is not intended to be a system to directly access the clients or to immediately report the results back. It is rather a longtime maintenance and monitoring system than a live interaction tool.

NOTE: Job Time Lag Limitation

The client will process one job at a time, report back the result, and then ask for the next job. If you create a persistent job with a time lag of only a few seconds, it will be repeated forever and block other jobs of this client. Therefore, adding jobs with a time lag smaller than one minute is not supported.

7.1.2 /usr/sbin/smt Commands

The main command to manage the SMT is smt (/usr/sbin/smt). The smt command should be used together with various sub-commands described in this section. If the smt command is used alone, it prints out a list of all available sub-commands. To get help for individual sub-commands, use smt subcommand --help.

The following sub-commands are available:

  • smt-client

  • smt-delete-registration

  • smt-job

  • smt-list-products

  • smt-list-registrations

  • smt-mirror

  • smt-ncc-sync

  • smt-register

  • smt-report

  • smt-repos

  • smt-scc-sync

  • smt-setup-custom-repos

  • smt-staging

  • smt-support

  • smt-sync

  • smt-mirror-sle9

There are two syntax types you can use with the smt command: either use smt followed by a sub-command or use a single command (composed of smt, dash, and the sub-command of choice). For example, it is possible to use either smt mirror or smt-mirror, as both have the same meaning.

NOTE: Conflicting Commands

Depending on your $PATH environment variable, the SMT smt command (/usr/sbin/smt) may collide with the smt command from the star package (/usr/bin/smt). Either use the absolute path /usr/sbin/smt, create an alias, or set your $PATH accordingly.

Another solution is to always use the smt- subcommand syntax (connected with a minus sign) instead of smt subcommand (separated by a space).

smt-client

The smt-client command shows information about registered clients. The information includes:

  • guid

  • hostname

  • patch status

  • timestamps of the patch status

  • last contact with the SMT server

The smt-client understands the following options:

--verbose or -v

Show detailed information about the client. The last contact date is shown as well.

--debug or -d

Enable debugging mode.

--logfile or -L file

Specify the file the log will be written to.

--hostname or -h name

Only the entries whose hostname begins with name will be listed.

--guid or -g guid

Only the entries whose GUID is guid will be listed.

--severity or -s level

Filter the result by the patch status information. The value level can be one of 'packagemanager', 'security', 'recommended' or 'optional'. Only those entries are listed which have patches of the respective level.

smt-delete-registration

The smt-delete-registration command deletes one or more registrations from SMT and Novell Customer Center. It will deregister machines from the system. The following options are available:

--guid ID or -g ID

Delete the machine with the guid ID from the system. You can use this option multiple times.

--debug or -d

Enable debugging mode.

smt-job

The smt-job script manages jobs for individual SMT clients. You can list, create, edit, or delete jobs with it. The following options are available:

--list or -l

List all client jobs. This is the default if the operation mode switch is omitted.

--verbose or -v level

Show detailed information about a job or jobs in a list mode. The level value can be a number from 0 to 3. The bigger the value, the more verbose the command is.

--create or -c

Create a new job.

--edit or -e

Edit an existing job.

--delete or -d

Delete an existing job.

--guid or -g guid

Specify the client's guid. This parameter can be used multiple times to create a job for more than one client.

--jobid or -j id

Specify the job ID. You need to specify job ID and client's guid when editing or deleting a job, because the same job for multiple clients has the same job ID.

--deleteall or -A id

Omit either the client's guid or the job ID in this delete operation. The missing parameter will match all clients respective jobs.

--type or -t type

Specify the job type. The type can be one of 'patchstatus', 'softwarepush', 'update', 'execute', 'reboot', 'wait', 'eject'. On the client, only 'patchstatus', 'softwarepush' and 'update' are enabled by default.

--description description

Specify a job description.

--parent id

Specify the job ID of the parent job. Use it to describe a dependency. A job will not be processed until its parent has successfully finished.

--name or -n name

Specify a job name.

--persistent

Specify if a job is persistent. Non-persistent jobs are processed only once, while persistent jobs are processed again and again. Use --timelag to define the time that elapses until the next run.

--finished

Search option for finished jobs.

--targeted time

Specify the earliest execution time of a job. Note that the job most likely will not run exactly at that point in time, but probably some minutes or hours after. The reason is that the client polls in a fixed interval for jobs.

--expires time

Define when the job will no longer be executed anymore.

--timelag time

Define the time interval for persistent jobs.

For a complete list of possible options and their explanation, see the manual page of smt-job command (man smt-job).

Examples

To list all finished jobs, enter the following:

smt-job --list --finished

To create a 'softwarepush' job that installs xterm and bash on client 12345 and 67890, enter the following:

smt-job --create -t softwarepush -P xterm -P bash -g 12345 -g 67890

To change the timing for a persistent job with job ID 42 and guid 12345 to run every 6 hours, enter the following:

smt-job --edit -j 42 -g 12345 --targeted 0000-00-00 --timelag 06:00:00

To delete all jobs with job ID 42, enter the following:

smt-job --delete -jobid 42 --deleteall

smt-list-products

The smt-list-products script lists all software products in the SMT database. The following options are available:

--used or -u

Show only used products.

--catstat or -c

Show whether all repositories needed for a product are locally mirrored.

smt-list-registrations

The smt-list-registrations script lists all registrations. There are two options available for this command.

--verbose or -v

Show detailed information about the registered devices.

--format or -f format

Format the output. Possible types of formats are asciitable and csv

smt-mirror

The smt-mirror command performs the mirroring procedure and downloads repositories that are set to be mirrored.

You can run the smt-mirror with the following options:

--clean or -c

Remove all files no longer mentioned in the metadata from the mirror. No mirroring occurs before cleanup.

--debug or -d

Enable the debugging mode.

--deepverify

Turn on verifying of all package checksums.

--hardlink size

Search for duplicate files with a size greater than the size specified in kilobytes. Creates hard links for them.

--directory path

Define the directory to work on. If you use this option, the default value configured in the smt.conf configuration file is ignored.

--dbreplfile file

Define the path to the *.xml file to use as database replacement. You can create such a file with the sync-ncc command.

--logfile file or -L file

Specify the path to a logfile.

smt-sync

The smt-sync or smt sync command gets data from the Novell Customer Center or SUSE Customer Center and updates the local SMT database. It can also save Novell Customer Center or SUSE Customer Center data to a directory instead of the SMT database, or read Novell Customer Center or SUSE Customer Center data from such a directory instead of downloading it from Novell Customer Center or SUSE Customer Center itself.

When using this command, it is automatically decided whether Novell Customer Center or SUSE Customer Center should be used. Then smt-ncc-sync or smt-scc-sync is called as appropriate.

smt-ncc-sync

The smt-ncc-sync or smt ncc-sync command gets data from the Novell Customer Center and updates the local SMT database. It can also save Novell Customer Center data to a directory instead of the SMT database, or read Novell Customer Center data from such a directory instead of downloading it from Novell Customer Center itself.

You can run the smt-ncc-sync with the following options:

--fromdir directory

Read Novell Customer Center data from a directory instead of downloading it from Novell Customer Center.

--todir directory

Write Novell Customer Center data to the specified directory without updating the SMT database.

--createdbreplacementfile

Create a database replacement file for using smt-mirror without database.

--logfile file or -L file

Specify the path to a log file.

--debug

Enable debugging mode.

smt-scc-sync

The smt-ccc-sync or smt scc-sync command gets data from the SUSE Customer Center and updates the local SMT database. It can also save SUSE Customer Center data to a directory instead of the SMT database, or read SUSE Customer Center data from such a directory instead of downloading it from SUSE Customer Center itself.

You can run the smt-scc-sync with the following options:

--fromdir directory

Read SUSE Customer Center data from a directory instead of downloading it from SUSE Customer Center.

--todir directory

Write SUSE Customer Center data to the specified directory without updating the SMT database.

--createdbreplacementfile

Create a database replacement file for using smt-mirror without database.

--logfile file or -L file

Specify the path to a log file.

--debug

Enable debugging mode.

smt-register

The smt-register or smt-register command registers all currently unregistered clients at the Novell Customer Center. It also registers all clients whose data has changed since the last registration.

The following options are available:

--logfile file or -L file

Specify the path to a log file.

--debug

Enable debugging mode.

smt-report

The smt-report or smt report command generates a subscription report based on local calculation or Novell Customer Center registrations.

The following options are available:

--local

Force the creation of a report based on a local calculation without accessing Novell Customer Center data.

--ncc

Force the creation of a report based on Novell Customer Center data.

--nonccsync

Disable synchronizing with Novell Customer Center before creating the report.

--mail or -m

Activate mailing the report to the addresses configured with the SMT Server and written in /etc/smt.conf. The report will be rendered as tables.

--attach or -a

Append the report to the e-mails in CSV format. This option should only be used together with the --mail option.

--quiet or -q

Suppress output to STDOUT and runs smt-report in quiet mode.

--csv or -c

The report will be exported to multiple files in CSV format. The first line of each *.csv file consists of the column names, the data starts on line two. The --csv parameter should only be used together with the --file parameter. If the specified filename contains .csv as extension, the report format will be CSV (as if the --csv parameter was used).

--pdf or -p

The report will be exported in PDF format. Use it only together with the -file option.

--xml

The report will be exported in XML format. Use it only together with the -file option. For a detailed description of this XML format, see the manual page of the smt-report command.

--file or -F

Export the report to one or several files. By default, the report will be written to a single file rendered as tables. Optionally, the filename or whole path may be specified after the parameter: --file filename. If no filename is specified, a default filename containing a timestamp is used. However, SMT will not check if the file or files already exist.

In CSV mode the report will be written to multiple files, therefore, the specified filename will expand to [path/]filename-reportname.extension for every report.

--logfile filename or -L filename

Specify path to a logfile.

--debug

Enable debugging mode.

smt-repos

You can use smt-repos (or smt repositories) to list all available repositories and for enabling, disabling, or deleting repositories. The following options are available:

--enable-mirror or -e

Enable repository mirroring.

--enable-by-prod or -p

Enable repository mirroring by giving product data in the following format: Product[,Version[,Architecture[,Release]]].

--disable-by-prod or -P

Disable repository mirroring by giving product data in the following format: Product[,Version[,Architecture[,Release]]].

--enable-staging or -s

Enable repository staging.

--disable-staging or -S

Disable repository staging.

--disable-mirror or -d

Disable repository mirroring.

--only-mirrorable or -m

List only repositories that can be mirrored.

--only-enabled or -o

List only enabled repositories.

--delete

List repositories and delete them from disk.

--namespace dirname

Delete the repository in the specified namespace.

--verbose or -v

Show detailed repository information.

smt-setup-custom-repos

The smt-setup-custom-repos or smt setup-custom-repos script is a tool to set up custom repositories (repositories not present in NU) to be used with SMT. You can use this script to add a new repository to the SMT database or to delete a repository from the database. The script recognizes the following options:

--productid

ID of a product the repository belongs to. If a repository should belong to multiple products, use this option multiple times to assign the repository to all relevant products.

--name

The name of the custom repository.

--description

The description of the custom repository.

--exturl

The URL where this repository can be mirrored from. Only HTTP and HTTPS protocols are supported (no directory, file, or FTP).

--delete

Remove a custom repository with a given ID from the SMT database.

To set up a new repository, use the following command:

smt-setup-custom-repos --productid Product_ID \
--name Catalog_Name --exturl URL

For example:

smt-setup-custom-repos --productid 434 \
--name My_Catalog --exturl http://my.example.com/My_Catalog

To remove a configured repository, use the following command:

smt-setup-custom-repos --delete Catalog_ID

For example:

smt-setup-custom-repos --delete 1cf336d819e8e5904f4d4b05ee081971a0cc8afc

smt-staging

A patch is an update of a package or group of packages. The term update and patch are often interchangeable. With the smt-staging script, you can set up patch filters for update repositories. It can also help you generate both testing repositories, or repositories for the production environment.

The first argument of smt-staging is always the command. It must be followed by a repository. The repository can be specified by Name and Target from the table scheme returned by the smt-repos command. Alternatively, it can be specified by its Repository ID, which is returned when running the commend smt-repos -v. The smt-staging script understands the following commands:

listupdates

List available patches and their allowed/forbidden status.

allow/forbid

Allow or forbids specified patches.

createrepo

Generate both testing and production repository with allowed patches.

status

Give information about both testing and production snapshots, and patch counts.

listgroups

List staging groups.

There is always one group available with the name default. The default group has the path repo/full, repo/testing and repo. With creating a new group, new paths can be specified.

creategroup

Create a staging group. Required parameters are: group name, testing directory name, and production directory name.

removegroup

Remove a staging group. Required parameter is: group name.

The following options apply to any smt-staging command:

--logfile or -L file path

Write log information to the specified file. If it does not exist, it is created.

--debug or -d

Turn on the debugging output and log.

--verbose or -v

Turn more detailed output on.

The following options apply to specific smt-staging commands:

--patch

Specify a patch by its ID. You can get a list of available patches with the listupates command. This option can be used multiple times. Use it with the allow, forbid, and listupdates commands. If used with listupdates, the command will print detailed information about the specified patches.

--category

Specify the patch category. The following categories are available: 'security', 'recommended' and 'optional'. Use it with the allow, forbid, and listupdates commands.

--all

Allow or forbid all patches in the allow or forbid commands.

--individually

Allow or forbid multiple patches (e.g. by category) one by one, that is, as if the --patch option had been used on each of the patches.

--testing

Use with the createrepo command to generate a repository for testing. The repository will be generated from the full unfiltered local mirror of the remote repository. It will be written into <MirrorTo>/repo/testing directory, where MirrorTo is the value taken from smt.conf.

--production

Use with the createrepo command to generate a repository for production use. The repository will be generated from the testing repository. It will be written into <MirrorTo>/repo directory, where MirrorTo is the value taken from smt.conf. If the testing repository does not exist, the production repository will be generated from the full unfiltered local mirror of the remote repository.

--group

Specify on which group the command should work on. The default for --group is the name default.

--nohardlink

During the repository creation with the createrepo command, avoid creating hard links instead of copying files. If not specified, hard links are created instead.

--nodesc

Do not print patch descriptions and summaries to save some screen space and make the output more readable.

--sort-by-version

Sort the listupdates table by patch version. The higher the version, the newer the patch should be.

--sort-by-category

Sort the listupdates table by patch category.

smt-support

The smt-support command manages uploaded support data usually coming from the supportconfig tool. You can forward the data to SUSE, either selectively or in full. This command understands the following options:

--incoming or -i directory

Specify the directory where the supportconfig archives are uploaded. You can also set this option with the SMT_INCOMING environment variable. The default SMT_INCOMING directory is /var/spool/smt-support.

--list or -l

List the uploaded supportconfig archives in the incoming directory.

--remove or -r archive

Delete the specified archive.

--empty or -R

Delete all archives in the incoming directory.

--upload or -u archive

Upload the specified archive to SUSE. If you specify -s, -n, -c, -p, and -e options, the archive is repackaged with contact information.

--uploadall or -U

Upload all archives in the incoming directory to SUSE.

--srnum or -s SR number

Accept the Novell Service Request 11 digit number.

--name or -n name

Enter the first and last name of the contact, in quotes.

--company or -c company

Enter the company name.

--storeid or -d id

Enter the store ID, if applicable.

--terminalid or -t id

Enter the terminal ID, if applicable.

--phone or -p phone

Enter the phone number of the contact person.

--email or -e email

Enter the email address of the contact.

7.1.3 rcsmt Init Script

The rcsmt script starts, restarts, or stops SMT services. If used without any sub-commands, it returns a help text. The rcsmt script can be used with the following sub-commands:

rcsmt start

Start the SMT services.

rcsmt stop

Stop the SMT services.

rcsmt status

Check the status of the SMT services. Checks whether httpd, MySQL, and cron are running.

rcsmt restart

Restart the SMT services.

rcsmt try-restart

Check whether the SMT services are enabled and if so, restart them.

You can enable and disable SMT with the YaST SMT Server module.