Content-type: text/html Manpage of zlman

zlman

Section: Software Management System (1)
Updated: 1.0
Index
 

NAME

zlman - zlman is the command-line interface to Novell ZENworks Linux Management (ZLM), which provides comprehensive Linux server and workstation management.  

SYNTAX

zlman <command> [--options] <arguments>

In general, zlman commands have both a short form and a long form. The long form is assembled in the form object-actionobject. For example, the command registration-list lists all registrations in a registration folder. There are a large number of commands, but you will find that most of them are easy to remember, since there are a limited number of objects (workstation, server, bundle, catalog, policy, administrator, registration) and actions (list, create, modify, delete) to perform on them.

Arguments for a command are ordered in the same way as the command itself: for catalog-addbundle, the catalog is named first and the bundle second. Option flags always come before any arguments.

The abbreviated form of each command uses one letter from each word in the long form: In this manner, admin-list is shortened to al. The exceptions to these general syntax rules are system commands such as ping and server-version which apply directly to the server.

For file names, you may use standard shell globbing: *.rpm is used to indicate "all files ending in .rpm."  

DESCRIPTION

ZENworks Linux Management (ZLM) is the next evolution in Linux server and workstation management. ZLM provides comprehensive Linux management, including:

- Advanced software package management, including dependency resolution, support for SUSE patches, and the ability to rollback to previous versions.
- Automated imaging and scripted installs using YAST autoinstall and RedHat* KickStart.
- Secure and fast graphical remote management of servers and desktops.
- Hardware, software, and Operating System inventory collection and reporting.
- Comprehensive policy-based management of Linux servers and desktops.
- Task-driven Web management interface.

The zlman command-line interface provides you a full-featured application that can simplify many operations using scripting, and provide quick access to operations. A comprehensive Web management interface with many advance features is also installed on your ZLM server.

 

GUIDE TO USAGE

This section contains a guide to general command formatting and conventions.

Administrators
Every action in zlman is governed by the access limitations of the administrator. The initial Administrator account created during the initial installation has rights to all objects. Additional administrator accounts you create are granted read-only rights by default. These accounts must be explicitly granted rights to any objects they are to manage.

Folders
If no folder is specified for commands which take a folder argument, the command targets the root folder. To specify a folder path, list each folder from the root separated by a forward slash (/). For example, if you have a folder named folder1 in the root, containing a subfolder named subfolder1, you would reference this folder as folder1/subfolder1. Each specified folder must already exist.

Ellipsis (...)
Ellipsis indicates that a command accepts multiple entries of the last argument type. For example, the ellipsis in this command:

zlman catalog-add-bundle [options] [catalog] [bundle] [...]

indicate that catalog-add-bundle can accept multiple bundles.

Option Flags
Commands that do not have command-specific options (they accept only the standard option flags) do not have options listed as an argument in the command reference. For example, the reference entry for the following command:

zlman workstation-list [folder] [filter]

Does not list options as part of the command, as it accepts only the standard flags. However, this command:

zlman workstation-messages [options] [workstation name]

Lists options with the other command arguments because this command has a command-specific option, -a.

 

~/.zlmanrc

Creating a .zlmanrc file in your home directory enables you to provide global options which are added to each command. For example, adding -U Administrator -P password causes each command to read your username and password from this file instead of prompting. To bypass the options stored in this file, use the --ignore-rc-file option.

 

COMMANDS

All of the commands below accept the option flags listed in the GLOBAL OPTIONS section. In addition, they accept individual options as listed with each command.

Registration Commands:
These commands allow you to create and alter registrations. Registration commands begin with "registration-" in the long form, or with the letter r in the short form.

registration-list (rl) [options] [folder] [filter]
Lists all registrations. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

registration-folder-create (rfc) [folder name] [containing folder]
Creates a folder called folder name in the location specified by folder.

registration-create-workstation (rcw) [key name] [workstation folder] [registration folder]
Creates a registration specifying membership in the specified workstation folder.

registration-create-server (rcs) [key name] [device folder] [registration folder]
Creates a registration specifying folder membership for servers.

registration-info -(ri) [key]
Displays detailed information about the specified registration.

registration-list-groups (rlg) [key]
Displays a list of the groups associated with the specified registration. Devices registering with this key are added to the listed groups.

registration-delete (rd) [key] [...]
Deletes the specified registration.

registration-update (ru) [options] [key]
Updates a registration by allowing you to change the properties of the registration key. Accepts the following options:
-k, --newkey=[key] - Updates the name of the key with the provided name.
-d, --desc=[description] - Updates the key description with the provided description.
-u, --usage=[count] - Updates the maximum number of devices which can be register using this key to the provided number.
--unlimited - Removes limits on the number of devices which can be created with this key.
-n, --nrule=[Naming Rule] - Specify a new naming rule, such as ${HostName}. Possible naming variables include '${Alias}', '${AssetTag}', '${CPU}', '${DNS}', '${DeviceType}', '${GUID}', '${HostName}', '${Location}', '${OS}'. Naming rules can contain a combination of variables, for example '${HostName}-${OS}'.
--workstation-folder=[Folder] - Specify a new folder to place workstations which register using this key.
--server-folder=[Folder] - Specifies a new folder to place servers which register using this key.

registration-add-workstation-group (rawg) [key] [group] [...]
Adds membership in the specified workstation group to objects registering using the specified key.

registration-add-server-group (rasg) [key] [group] [...]
Adds membership in the specified server group to objects registering using the specified key.

registration-remove-workstation-group (rrwg) [key] [group] [...]
Removes the membership in the specified group from the registration key. Any device that has previously registered using this key does not lose group membership. This change applies only to new devices using this registration.

registration-remove-server-group (rrsg) [key] [group] [...]
Removes the membership in the specified group from the registration key. Any device that has previously registered using this key does not lose group membership. This change applies only to new devices using this registration.

registration-move (rmv) [key] [new folder]
Moves the specified registration to the specified folder.

Administrator Commands:
These commands are used to create and adjust administrator accounts. Administrator commands begin with "admin-" in the long form or the letter a in the short form.

admin-list (al) [options] [folder]
Lists all administrator accounts. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

admin-create (ac) [administrator] [password]
Creates a new administrator account. By default, this account is created with view-only rights to all objects. Use the fBadmin-assign-rights command to grant additional rights to this account.

admin-delete (ad) [administrator] [...]
Deletes an administrator account.

admin-rename (ar) [current name] [new name]
Renames the administrator account specified by current name to new name.

admin-rights-assign (ara) [options] [administrator] [object name] [...]
Assigns the specified administrator rights to the object specified by object. One of the following options must be specified to indicate the object type:
-w,--workstations
-s,--servers
-a,--administrators
-b,--bundles
-p,--policies
-R,--reports
-r,--registrations

Additionally, this command accepts the following option flags:

-n,--none - All rights to the specified object are revoked.
-v,--view - Grant view-only access to the specified object.
-m,--modify - Grant rights to modify the specified object.
-c,--create - Grant rights to create new objects.

admin-rights-get (arg) [options] [administrator] [object]
Displays the effective rights of administrator to the specified object. If no object is specified, all rights are displayed. One of the following options must be specified to indicate the object type:
-w,--workstations
-s,--servers
-a,--administrators
-b,--bundles
-p,--policies
-R,--reports
-r,--registrations

zlm-debug
Tars up all the log files into /tmp/xlm-debug-inf-<date>.tgz. Usage: /opt/novell/zenworks/bin/zlm-debug [options]

--modules-dir= Specify the directory modules directory.
--tar-dir= Specify the directory to place the tarball in.
-h,--help Print this message.
-a,--no-cache Don't collect any cache data.
-c,--no-client Don't collect client data.
-o,--no-config Don't collect config data.
-d,--no-hardware Don't collect hardware data.
-l,--no-logs Don't collect logs.
-p,--no-packages Don't collect package data.
-s, --no-server Don't collect server data.

Bundle Commands:
These commands are used to create and modify bundles and folders, including adding packages to bundles and creating patch bundles. Note that zlman treats objects and their corresponding folders as one object type. zlman bundle-rename can rename bundles or bundle folders; zlman bundle-move can move bundles or bundle folders, etc. Bundle commands begin with "bundle-" in the long form, or with the letter b in the short form, with the exception of the patch bundle command which begins with p.

bundle-list (bl) [options] [folder]
Lists all bundles and bundle folders in the specified folder. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

bundle-create (bc) [name] [folder]
Creates a new bundle. If a folder is provided, the bundle is created in the specified folder. Accepts the following option flag:
-t --type - Specifies the type of bundle to be created. Valid types are "package" and "file." For example, bundle-create -t file MyFileBundle.

bundle-folder-create (bfc) [name] [folder]
Creates a new folder for containing bundles at the path specified by folder.

bundle-delete (bd) [bundle] [...]
Deletes one or more bundles or bundle folders.

bundle-rename (br) [current name] [new name]
Renames the specified bundle or bundle folder to the name specified by new name.

bundle-move (bmv) [object] [new folder]
Moves the specified bundle or bundle folder to the specified folder.

bundle-add-package (bap) [options] [bundle] [target] [package file] [...]
Adds a package to a bundle. Accepts the following arguments:
Bundle - An existing bundle to which you want to add one or more RPM packages.
Target - OS/Platform targets. (valid targets for your environment can be viewed using zlman tl.)
Package File - RPM format package file.

Accepts the following option flags:
--installtype=[upgrade|install] - A value of upgrade triggers rpm -u behavior, while a value of install triggers rpm -i behavior.

bundle-copy-package (bcp) [source bundle] [target bundle]

bundle-list-packages (blp) [bundle] [target]
Displays a list of packages contained in the specified bundle, including the bundle ID.

bundle-list-version (blv) [bundle]
Displays a list of the version numbers for the specified bundle.

bundle-remove-package (brp) [bundle] [target] [package ID] [...]
Removes a package from a bundle. Use the bundle-list-packages command to find the package ID.

bundle-group-create (bgc) [name] [containing folder]
Creates a bundle group.

bundle-group-members (bgl) [bundle group]
Lists the members of a bundle group.

bundle-group-add (bga) [bundle group] [bundle] [...]
Adds a bundle to a bundle group.

bundle-group-remove (bgr) [bundle group] [bundle] [...]
Removes a bundle from a from the specified bundle group.

patch-bundle-create (pbc) [product name] [product version] [product arch] [patch file] [folder]
Creates a new patch bundle. Accepts the following arguments:
Product Name - Name of the product to which this patch applies, must be one of the following: 'SUSE LINUX', 'SUSE SLES', 'SUSE CORE', 'Novell Linux Desktop', 'SuSE SLES'
Product Version - Version of the product to which this patch applies.
Product Arch - Product architecture, must be one of the following: 'i386', 'x86_84'
Patch File - File containing the patch.
Folder - Bundle folder to place this patch bundle.

bundle-add-file (baf) [options] [bundle] [file] [...]
Adds a file to a bundle. Accepts the following arguments:
Bundle - An existing bundle to which you want to add one or more files.
File - The file being added. Accepts the following option flags:
--destination=[path] - Full path where the file should be deployed on the client.
--unpack - Indicates that this file is compressed and should be decompressed and extracted on the client.
--permissions=[xxx] - Unix file permissions to be applied to this file after deployment (not applicable for compressed files.)

bundle-list-files (blf) [bundle] [target]
Displays a list of files contained in the specified bundle, including the bundle ID.

bundle-remove-file (brf) [bundle] [target] [file ID] [...]
Removes a package from a bundle. Use the bundle-list-files command to find the file ID.

Catalog Commands:
These commands are used to create and modify catalogs, including adding bundles to catalogs. Catalog commands begin with "catalog-" in the long form, or with the letter c in the short form.

catalog-list (cl) [options] [folder] [filter]
Lists catalogs in a folder. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

catalog-create (cc) [catalog name] [containing folder]
Creates a new catalog.

catalog-folder-create (cfc) [folder name] [containing folder]
Creates a new folder for containing catalogs. If a folder is provided, the catalog is created in the specified folder. The containing folder can be a path to an existing catalog folder, such as folder/subfolder.

catalog-delete (cd) [catalog] [...]
Deletes the specified catalog.

catalog-rename (cr) [existing name] [new name]
Renames the specified catalog.

catalog-move (cmv) [catalog] [new folder]
Moves the specified catalog to the location specified by new folder.

catalog-list-bundles (clb) [catalog]
Displays a list of all bundles associated with the specified catalog.

catalog-add-bundle (cab) [options] [catalog] [bundle] [...]
Associates one or more bundles with a catalog. Accepts the following option flags:
--dry-run - Perform a dry run.
-a, --allow-removal - Allow removal of a bundle.
--prepare-time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--prepare-date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formated as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

catalog-remove-bundle (crb) [catalog] [bundle] [...]
Removes the specified bundle from the specified catalog.

Package Commands:
These commands are used to modify packages. Package commands begin with "package-" in the long form, or with the letter p in the short form.

package-list-bundles (plb) [package filename]
Displays a list of the bundles that contain the specified package.

package-replace-packages (prp) [target] [package filename] [...]
Replaces the specified package with another of the same name, epoch, version, release, architecture, and target. You can replace multiple packages by specifying multiple filenames.


                                              

Workstation Commands:
These commands are used to manage workstations. Workstation commands begin with "workstation-" in the long form, or with the letter w in the short form.

workstation-info (wi) [workstation]
Displays detailed information about the specified device.

workstation-list (wl) [options] [folder] [filter]
Lists the workstations contained in the specified folder. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

workstation-messages (wm) [options] [workstation name]
Displays a list of unacknowledged messages associated with the specified device. Accepts the following option flags:
-a, --all - Displays all messages including acknowledged messages.

workstation-ack (wa) [workstation name] [log id] [...]
Acknowledges a message associated with a workstation.

workstation-delete (wd) [workstation] [...]
Deletes one or more workstation devices, folders or groups.

workstation-refresh (wr) [workstation]
Refreshes all policies and bundles on one or more device, folder or group. Accepts the following option flags:
--service=[service] - Specify a specific service to refresh. Service must be one of the following: 'registration', 'Log', 'policymanager', 'settings', 'inventory'.

workstation-rename (wrn) [existing name] [new name]
Renames a workstation.

workstation-move (wmv) [workstation name] [new folder]
Moves a workstation to a different folder.

workstation-folder-create (wfc) [folder name] [containing folder]
Creates a new folder.

workstation-group-create (wgc) [group name] [containing folder]
Creates a new group.

workstation-group-members (wgm) [group]
Lists members of a group.

workstation-group-add (wga) [group] [workstation] [...]
Add one or more device to a group.

workstation-group-remove (wgr) [group] [workstation] [...]
Remove one or more members of a group.

workstation-list-bundles (wlb) [workstation]
List bundles associated with a device.

workstation-add-bundle (wab) [options] [workstation] [bundle] [...]
Associate one or more bundles with a device. Accepts the following option flags:
--dry-run - Perform a dry run.
-a, --allow-removal - Allow removal of a bundle.
--prepare-time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--prepare-date=<YYYY-MM-DD> Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--time=<HH:MM>
- Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formatted as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

workstation-remove-bundle (wrb) [workstation] [bundle] [...]
Remove the association between a device and one or more bundles.

workstation-list-catalogs (wlc) [workstation]
List catalogs associated with a device.

workstation-add-catalog (wac) [options] [workstation] [catalog]
Associate one or more catalogs with a device. Accepts the following option flags:
--dry-run - Perform a dry run.
-a, --allow-removal - Allow removal of a bundle.
--prepare-time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--prepare-date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formatted as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

workstation-remove-catalog (wrc) [workstation] [catalog] [...]
Remove the association between a device and one or more catalogs.

workstation-list-policies (wlp) [workstation]
List policies associated with a device.

workstation-add-policy (wap) [workstation] [policy] [...]
Associate one or more policies with a device. Accepts the following option flags:
--time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formatted as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

workstation-remove-policy (wrp) [workstation] [policy] [...]
Remove the association between a device and the specified policies.
                                           

Server Commands:
These commands are used to manage servers. Server commands begin with "server-" in the long form, or with the letter s in the short form.

server-info (si) [server]
Displays detailed information about the specified device.

server-list (sl) [options] [folder] [filter]
Lists devices in the specified folder. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

server-messages (sm) [options] [server]
Displays a list of unacknowledged messages associated with the specified device. Accepts the following option flags:
-a, --all - Displays all messages including acknowledged messages.

server-ack (sa) [server] [log id] [...]
Acknowledges a message associated with a device.

server-delete (sd) [server] ...
Deletes one or more devices, folders or groups.

server-refresh (sr) [options] [server]
Refreshes all policies and bundles on one or more device, folder or group. Accepts the following option flags:
--service=[service] - Specify a specific service to refresh. Service must be one of the following: 'registration', 'Log', 'policymanager', 'settings', 'inventory'.

server-rename (srn) [existing name] [new name]
Renames a device.

server-move (smv) [server] [folder]
Moves a device to a different folder.

server-folder-create (sfc) [folder name] [containing folder]
Creates a new folder.

server-group-create (sgc) [name] [folder]
Creates a new group.

server-group-members (sgm) [group]
Lists members of a group.

server-group-add (sga) [group] [server] [...]
Adds one or more device to a group.

server-group-remove (sgr) [group] [server]
Remove one or more members of a group.

server-list-bundles (slb) [server]
List bundles associated with a device.

server-add-bundle (sab) [options] [server] [bundle]
Associate one or more bundles with a device. Accepts the following option flags:
--dry-run - Perform a dry run.
-a, --allow-removal - Allow removal of a bundle.
--prepare-time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--prepare-date=<YYYY-MM-DD> Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--time=<HH:MM>
- Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formatted as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

server-remove-bundle (srb) [server] [bundle] [...]
Remove the association between a device and one or more bundles.

server-list-catalogs (slc) [server]
List catalogs associated with a device.

server-add-catalog (sac) [options] [server] [catalog] [...]
Associate one or more catalogs with a device. Accepts the following option flags:
--dry-run - Perform a dry run.
-a, --allow-removal - Allow removal of a bundle.
--prepare-time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--prepare-date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formatted as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

server-remove-catalog (src) [server] [catalog] [...]
Removes the association between a device and one or more catalogs.

server-list-policies (slp) [server]
Lists policies associated with a device.

server-add-policy (sap) [options] [server] [policy] [...]
Associates one or more policies with a device. Accepts the following option flags:
--time=<HH:MM> - Specify a time of day that the action should be performed. The time should be specified in the format "HH:MM", with hours in 24 hour format.
--date=<YYYY-MM-DD> - Specify a specific date that the action should be performed. The date should be specified in the format "YYYY-MM-DD".
--now - Specify that the action should be performed as soon as possible. A repeat frequency may be specified. If no other schedule is specified it will default to now.
--relative=<DD:HH:MM> - Specify that the action should be performed at a time relative to now. The time should be formatted as "DD:HH:MM". A repeat frequency may be specified.
--weekly=<MWF> - Specify the days of the week the action should be performed on. If specified the action will be repeated every 7 days. Example: "MWF" would execute the action every Monday, Wednesday and Friday. Monday = M, Tuesday = TU, Wednesday = W, Thursday = TH, Friday = F, Saturday = SA, Sunday = SU.
--monthly=<DD> - Specify the day of the month that the action should be performed on. If specified the action will be repeated every month. Multiple days may not be specified.
--yearly=<MM-DD,MM-DD,...> - Specify the days of the year that the action should be performed on. If specified the action will be repeated every year. Dates should be specified in the format "MM-DD". Multiple dates may be comma separated.
--repeat=<DD:HH:MM> - Specify the repeat frequency for the action, in the format "DD:HH:MM". Days are optional.
--gmt - All times given will be treated as GMT. If not given all times will be treated as the local time of the device.

server-remove-policy (srp) [server] [policy] [...]
Removes the association between a device and one or more policies.

server-health (sh) [server]
Displays the health status of a devices.
                                              

Ruleset Commands:
These commands are used to create and modify rule sets. Rule sets are applied to new devices registering to your server that do not present a registration key. Rule set commands begin with "ruleset-" in the long form, or with the letters rs in the short form.
                                              

ruleset-list (rsl) [options]
Lists all rule sets. Accepts the following option flags:
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

ruleset-create-workstation (rscw) [name] [position]
Creates a new rule set to apply when a workstation registers without a key.
  
ruleset-create-server (rscs) [name] [position]
Creates a new rule set to apply when a server registers without a key.

ruleset-delete (rsd) [name or position]
Removes a rule set.

ruleset-info (rsi) [name or position]
Displays detailed information about a rule set.

ruleset-list-groups (rslg) [name or position]
Displays a list of groups that a device will be a member of when they are created with the specified rule set.

ruleset-update (rsu) [options] [name or position]
Updates values of a rule set. Accepts the following options:
-k, --newname=<key> - Specify a new name for the given rule set.
-n, --nrule=<Naming Rule> - Specify a new naming rule for the given rule set.
--workstation-folder=<Folder> - Specify a new folder to place workstations in when they are created with the specified rule set.
--server-folder=<Folder> - Specify a new folder to place servers in when they are created with the specified rule set.

ruleset-move (rsmv) [name or position] [new position]
Changes the position of a rule set.

ruleset-add-rule (rsar) [name or position] [attribute] [operator] [value]
Add a rule to a rule set. Each rule defines a condition which must be met in order for a rule set to be applied to a device. Each rule in a rule set must evaluate to TRUE in order for the rule set to be applied. Accepts the following arguments:
attribute - Valid attributes are: 'Alias', 'AssetTag', 'CPU', 'DNS', 'DeviceType', 'GUID', 'HostName', 'IPAddress', 'Location', 'MacAddress', 'OS', and 'SubnetMask'.
operator - Valid string operators are: 'contains', 'starts', 'ends', 'equals'. Valid integer operators are: '<', '<=', '=', '>', '>='.
value - The format and contents of value are determined by the attribute. For additional information about attribute values see the Inventory section in the ZENworks Linux Management Administration Guide.

ruleset-remove-rule (rsrr) [ruleset name or position] [rule position]
Removes a rule from a rule set.

ruleset-add-workstation-group (rsaw) [name or position] [group] [...]
Adds server group membership to objects imported with a given rule set. Any workstations that satisfy each rule condition of the rule set are added to the specified groups.

ruleset-add-server-group (rsas) [name or position] [group] [...]
Adds workstation group membership to objects imported with a given rule set. Any servers that satisfy each rule condition of the rule set are added to the specified groups.

ruleset-remove-workstation-group (rsrw) [name or position] [group] [...]
Removes workstation group membership from a rule set. Group membership for devices that have already registered is unaffected. This applies only to new devices when they register.

ruleset-remove-server-group (rsrs) [name or position] [group] [...]
Removes server group membership from a rule set. Group membership for devices that have already registered is unaffected. This applies only to new devices when they register.

License Commands:
These commands are used to activate your server or display licensing information. License commands begin with "license-" in the long form, or with the letter l in the short form.
                                              

license-info (li)
Displays licensing information.

license-activate (la) [key]
Activates your system.

license-set-seats (lss) [count]
Sets the number of allowed active devices.

Target Commands:
These commands are used to create and manage the list of valid OS targets. Target commands begin with "target-" in the long form, or with the letter t in the short form.
                                                                                        

target-list (tl) [options]
Displays a list of current OS targets. Accepts the following option flags:
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

target-create (tc) [name] [arch] [Package Manager] [Primary Role] [Product Name] [Vendor] [Version] [Detect String]
Create a new OS target. Accepts the following arguments:
name - Target name, for example sles-9-i586.
arch - Architecture, for example i586 or x86_64.
Package Manager - System package manager, for example rpm.
Primary Role - Role of the operating system, set to Server or Workstation.
Product Name - Name of the product, for example SuSE Linux Enterprise Server.
Vendor - Product vendor, for example Novell or SUSE.
Version - Product version, for example 9 for SuSE Linux Enterprise Server.
Detect String - Location where the OS and version can be read on the system. For example, the SLES 9 detect string is <file source="/etc/SuSE-release" substring="SUSE LINUX Enterprise Server 9"/>. This detect string looks for "SUSE LINUX Enterprise Server 9" in /etc/SuSE-release to find a match for this target.

target-info (ti) [target]
Displays detailed information about an OS target.

target-update (tu) [options] [target]
Modify values for a user created OS target. Accepts the following options:
--arch=<arch> - Specify a new arch value.
--pkgmgr=<Package Manager> Specify a new Package Manager value.
--enable - Enable a disabled OS Target.
--disable - Disable an enabled OS Target.
--role=<Primary Role> - Specify the primary role of this target.
--product=<Product Name> - Specify a new product name.
--vendor=<Vendor> - Specify a new Vendor.
--detect=<Detect String> - Specify the OS detection string.
--version=<Version> - Specify a new version.

target-delete (td) [target]
Delete a user-defined OS target.
  

Queue Commands:
These commands are used in situations when you need to make modifications to the queue. The queue processes asynchronous events such as XML file regeneration and client refreshes, and does not need to be modified under most circumstances. Queue commands begin with "queue-" in the long form, or with the letter q in the short form.

Flush deletes items from the queue, and reset turns them back to New.
  

queue-list (ql) [status]
List all queue entries. If a status is provided, only queue entries matching the specified status are displayed. Accepts the following option flags:
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

queue-reset (qr)
Resets the queue, setting the status of all queue entries to New.

queue-flush (qf)
Marks as "Failed" all the entries in the queue with status <status>. Possible values are
N -new
F -failed
S -succeeded
I -in progress
You can invoke zlman qf without status. For example, zlman qf will attempt to mark all the queue's entries as Failed.

Hotlist Commands:
This command is used to view the list of devices which have unacknowledged warnings or errors.

hotlist

Displays a list of devices which have unacknowledged warnings or errors. Warning or errors can be acknowledged using the workstation-ack and server-ack commands. Once all warnings or errors for a device are acknowledged it no longer appears on the hotlist.
                                              

Policy Commands:
These commands are used to modify and manage policies. Policies must be initially created using the ZENworks Control Center. Policy commands begin with "policy-" in the long form, or with the letter p in the short form.

policy-list (pl) [options] [folder] [filter]
Lists policies in a folder. Accepts the following option flags:
-r,--recursive - Includes subfolders.
-f,--filter - Displays options matching the specified filter. Wild card * and ? can be used if they are enclosed in quotations.

policy-folder-create (pfc) [name] [containing folder] Creates a new folder for containing policies.

policy-delete (pd) [policy] [...]
Deletes a policy.

policy-rename (pr) [existing name] [new name]
Renames a policy.

policy-move (pmv) [policy] [folder]
Moves a policy.

policy-group-create (pgc) [group name] [folder]
Creates a policy group.

policy-group-members (pgl) [group]
Lists the members of a policy group.

policy-group-add (pga) [group] [policy] [...]
Adds a policy to a policy group.

policy-group-remove (pgr) [group] [policy]
Removes a policy from a policy group.

 

GLOBAL OPTIONS

The following options can be applied to any zlman transaction:

-?, --help, -?
Used without a command, this flag displays a list of commands and exits. Used with a command, it displays a list of available options for the command.

-U, --user=<username> -
Provide a user name. If not provided, you are prompted.

-P, --password=<password>
Specify a password. If not provided, you are prompted.

--log=<logfile> -
Specify the log file. (default: /var/opt/novell/log/zenworks/zlman.log)

-d, --debug -
Display debugging output.

--version -
Print zlman version and exit.

-V, --verbose -
Enable verbose output.

--quiet
Quiet output, print only error messages.

--ignore-rc-file
Ignore the ~/.zlmanrc file.

--host=<host>
Specify the host name to connect to. (default: localhost)

--port=<port>
Specify the port that the server is listening on. (default: 443)

--cleartext
Disable SSL for debugging purposes. Port must be set to the clear text port.

 

TIME FORMATS

zlman understands a variety of time formats. You may use:

UNIX time:
The number of seconds since January 1, 1970. For example, 1064503775.

Written date formats:
Thu May 29 13:28:47 2003, Thu May 29 13:28:47 EDT 2003 and 29 May 2003 13:28:47 EDT are all valid.

Numeric date formats
All-numeric date formats such as 2003-05-29 13:28:47 or 03-05-29 13:28:47 will work. Dashes indicate dates, and colons indicate times. The order of the date numerals will vary by locale settings.

24-hour or 12-hour time
Both 13:28:47 and 1:28:47 PM are acceptable.

All times are converted to UTC, and used without regard to time zones. If you wish to execute a transaction at a particular local time, you will need to create one transaction for each time zone.

 

AUTHORS

Copyright 2005, Novell, Inc. All rights reserved. http://www.novell.com  

SEE ALSO

zlmmirror(1), rug(1)


 

Index

NAME
SYNTAX
DESCRIPTION
GUIDE TO USAGE
~/.zlmanrc
COMMANDS
GLOBAL OPTIONS
TIME FORMATS
AUTHORS
SEE ALSO