ZENworks 10 Configuration Management Command Line Utilities Reference
Legal Notices
Novell, Inc. makes no representations or warranties with respect to the contents or use of this documentation, and
specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.
Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time,
without obligation to notify any person or entity of such revisions or changes.
Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaims
any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc.
reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to
notify any person or entity of such changes.
Any products or technical information provided under this Agreement may be subject to U.S. export controls and the
trade laws of other countries. You agree to comply with all export control regulations and to obtain any required
licenses or classification to export, re-export or import deliverables. You agree not to export or re-export to entities on
the current U.S. export exclusion lists or to any embargoed or terrorist countries as specified in the U.S. export laws.
You agree to not use deliverables for prohibited nuclear, missile, or chemical biological weaponry end uses. See the
Novell International Trade Services Web page (http://www.novell.com/info/exports/) for more information on
exporting Novell software. Novell assumes no responsibility for your failure to obtain any necessary export
approvals.
6ZENworks 10 Configuration Management Command Line Utilities Reference
About This Guide
novdocx (en) 16 April 2010
This Novell ZENworks 10 Configuration Management Command Line Utilities Reference includes
information to help you use the following Novell
utilities:
zman(1)
zeninfocollect(1)
zac(1)
The information in this guide is organized as follows:
Chapter 1, “ZENworks Command Line Utilities,” on page 9
Chapter 2, “Command Line Utilities for Linux Satellites,” on page 89
Chapter 3, “ZENworks Diagnostic Center,” on page 99
Chapter 4, “Troubleshooting ZENworks Command Line Utilities,” on page 103
Chapter 5, “Guidelines for Working with Zman,” on page 105
Appendix A, “Documentation Updates,” on page 107
Audience
This guide is intended for ZENworks administrators.
Feedback
®
ZENworks® 10 Configuration Management
We want to hear your comments and suggestions about this manual and the other documentation
included with this product. Please use the User Comments feature at the bottom of each page of the
online documentation, or go to the Novell Documentation Feedback site (http://www.novell.com/
documentation/feedback.html) and enter your comments there.
Additional Documentation
ZENworks 10 Configuration Management is supported by other documentation (in both PDF and
HTML formats) that you can use to learn about and implement the product. For additional
documentation, see the ZENworks 10 Configuration Management documentation (http://
www.novell.com/documentation/zcm10/).
Documentation Conventions
In Novell documentation, a greater-than symbol (>) is used to separate actions within a step and
items in a cross-reference path.
®
A trademark symbol (
trademark.
When a single pathname can be written with a backslash for some platforms or a forward slash for
other platforms, the pathname is presented with a backslash. Users of platforms that require a
forward slash, such as Linux*, should use forward slashes as required by your software.
, TM, etc.) denotes a Novell trademark. An asterisk (*) denotes a third-party
About This Guide7
novdocx (en) 16 April 2010
8ZENworks 10 Configuration Management Command Line Utilities Reference
1
ZENworks Command Line Utilities
The following sections give information on the Novell® ZENworks® 10 Configuration Management
command line utilities:
“zman(1)” on page 10
“zeninfocollect(1)” on page 78
“zac(1)” on page 80
novdocx (en) 16 April 2010
1
ZENworks Command Line Utilities
9
zman(1)
Name
zman - The command line interface to Novell ZENworks 10 Configuration Management, which
provides comprehensive server, workstation, and user management, and to Novell 10 Asset
Management, which provides software and hardware inventory of servers and workstations,
software usage tracking, and software license compliance.
Description
The zman command line interface provides you a full-featured utility that can simplify many
operations by using scripting and can provide quick access to operations. It can be used effectively
in automation of tasks.
The following sections provide information about all of the commands provided for ZENworks 10
Configuration Management and ZENworks 10 Asset Management. Some of the commands apply to
both products, and some apply to only one or the other.
novdocx (en) 16 April 2010
The following commands apply only to ZENworks 10 Configuration Management. If Configuration
Management is not installed or active, the commands have no effect:
The following commands apply only to ZENworks 10 Asset Management. If Asset Management is
not installed or active, the commands have no effect:
Asset Management commands
Syntax
zman <command> [-options] [arguments]
In general, zman commands have both a short form and a long form. The long form is assembled in
the form category-action. For example, the command
a registration folder. There are many commands, but most of them are easy to remember because
they are grouped under categories (workstation, server, bundle, policy, administrator, registration,
etc) and most actions (list, create, modify, delete) to perform on them are common.
The abbreviated form of each command uses one letter from each word in the long form. In this
manner,
uniqueness of the short names. For example,
short form of
admin-list
bundle-copy
is shortened to al. There are some exceptions to this rule to maintain the
bc
.
registration-list
is the short form of
bundle-create
lists all registrations in
, and
bcp
is the
A command takes options and arguments. Options can be specified anywhere in the command.
Arguments are dependent on position.
10ZENworks 10 Configuration Management Command Line Utilities Reference
Options
Options are of two types: switches and flagged options. Both have a short and long form. The short
form is preceded by a single hyphen and the long form is preceded by two hypens. For example, -n
and --namefilter are the short and long forms of a flagged option used to filter the display of results
by name for the bundle-list command.
Switch: A parameter that does not take any value. Its presence alone conveys the meaning. For
example, specifying the –recursive switch in
bundle-list
indicates that the contents of the
subfolders should also be displayed.
Flagged Option: This parameter is used to set a value for an option. The value is given followed by
a space or equals sign after the short or long flag of the option.
novdocx (en) 16 April 2010
Example:
zman bundle-list -namefilter "bundle*" -r
Arguments
Arguments for a command are usually ordered in the same way as the command itself. For example,
server-add-bundle
for
, the server is named first and the bundle second.
Guide to Usage
This section contains a guide to general command formatting and conventions.
Administrators
Every action in zman 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.
Help
The zman command line interface provides help at several levels. Pipeline the help through the
more
operating system's native
At the highest level, lists all the categories of commands available in zman and the global
options for the commands.
Example:
At the all category level, lists all the commands available in zman organized by categories
For each category, lists the commands available specific to that category.
zman -h
command for scrollable output.
Example:
At each command level, gives usage, detailed help, and examples for a particular
zman policy /?
command.
Example:
-h,--help,?,-?,
zman policy-list-help
and
/?
are the various help options available.
ZENworks Command Line Utilities11
Folders
If no folder is specified for commands that 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
named
subfolder1
, you would reference this folder as
folder1
in the root, containing a subfolder
folder1/subfolder1
. Each specified
folder must already exist.
Mandatory and Optional arguments
Arguments enclosed inside parentheses ( ) are mandatory and those enclosed by square
brackets [ ] are optional.
Ellipsis (...)
An ellipsis indicates that a command accepts multiple entries of the last argument type. The
arguments must be separated by space or commas, depending on the command. For example:
The ellipsis indicates that
level help, the multiple entry argument help is given as
(bundle)]
for more clarity.
All commands that have multiple entries of the last argument also have the -
server-add-bundle
can accept multiple bundles. In the command
[(bundle) (bundle) ...
f|--folder
option. This option is convenient if all the entries of the argument are under the same folder.
The path of the entries are calculated relative to this folder path. For example:
zman server-add-bundle server bundle1 bundle2 --folder bundlefolder
Path of the ZENworks Objects
If the argument required is the path of a ZENworks object, the path must be specified relative to
the root folder of that object separated by a forward slash (/), unless it is specified in the
command help to enter the absolute path. For example:
to export bundles, policies, and settings definitions
respectively to a specified file in the XML format. The file is created with the specified name
.xml
and file extension. If the file extension is not specified, the
extension is added by default.
You can use these files to create bundles, policies, and settings.
Asset Management Commands
These commands are used to load purchase record files and refresh the compliance engine. They
apply only to ZENworks 10 Asset Management.
12ZENworks 10 Configuration Management Command Line Utilities Reference
novdocx (en) 16 April 2010
asset-management-load-purchase-record (amlpr)
Loads a purchase record file. The Purchase Record Loader looks for the purchase record file to
load on the primary server in the folder
uploaded
. If you have not yet used the Purchase Record Loader from ZENworks Control
ZENWORKS_HOME/temp/PurchaseRecordImport/
Center, you need to create this folder.
This command is asynchronous, which means
zman
returns immediately and does not wait for
the command to complete. This is because the command may run for a long time. You can
check the status of this process from ZENworks Control Center.
asset-management-refresh-compliance-data (amrcd)
Runs the software compliance engine to refresh the software license compliance data.
This command is asynchronous, which means zman returns immediately and does not wait for
the command to complete. This is because the command may run for a long time. You can
check the status of this process from ZENworks Control Center.
Administrator Commands
These commands are used to create and manage administrator accounts. Administrator commands
begin with
admin-
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.
in the long form or the letter a in the short form.
admin-clear-credential (acc)
Clears the ZENworks username and password stored by using the
admin-store-credential
command. It is always safer and is a good practice to delete the stored credentials after you are
finished executing the commands.
admin-create (ac) [options] (administrator or user)
Creates a ZENworks administrator account.
(administrator or user) - Name of the administrator or full path of a user in a user source.
Accepts the following options:
-f, --fullname=[full name] - Full name of the ZENworks administrator.
-a, --assign-same-rights - Gives the new administrator the same rights as the administrator who
executes this command.
The command prompts for the password of the administrator, to avoid entering the password in
clear text. If the administrator account is based on a user, it uses the same credentials defined in
the user source so the command does not prompt for the password.
Deletes rights assigned to a ZENworks administrator account.
[object path] [...] - Full path of the ZENworks object, starting with a forward slash (/).
Accepts the following option:
-c, --category=[rights category] - Name of the category within which the rights are grouped. To
Displays rights assigned to a ZENworks administrator account.
[object path] [...] - Full path of the ZENworks object, starting with a forward slash (/).
Accepts the following options:
-c, --category=[rights category] - Name of the category within which the rights are grouped. To
see the list of categories, run
zman admin-rights-set --Help | more
.
-e, --effective - Displays the effective rights of the administrator. Effective rights include rights
inherited from roles assigned to the administrator. If this option is not specified, rights
assigned directly to the administrator are displayed.
-l, --longnames - Displays names for the rights. By default, the abbreviated form of the rights
Allows or denies rights for a ZENworks administrator account.
[rights category] - Name of the category under which the rights are grouped. To see the list of
categories, run
zman admin-rights-set --Help | more
.
[object path] [...] - Full path of the ZENworks object, starting with forward slash (/), on which
the rights should be enforced. To view the root folders of the allowed object types for which
rights can be assigned within each rights category, run
| more
.
zman admin-rights-modify --Help
Accepts the following options:
14ZENworks 10 Configuration Management Command Line Utilities Reference
-a, --allow=[right ][...] - A comma-separated list of long or short names of the rights to be
allowed. To view the rights for each category, run
.
more
zman admin-rights-set --Help |
-A, --allow-all - Allows all rights of the Rights category.
-d, --deny=[right ][...] - A comma-separated list of long or short names of the rights to be
denied. To view the rights of each category, run
.
more
zman admin-rights-set --Help |
-D, --deny-all - Denies all rights of the Rights category.
-f, --folder=[folder name] - Full path of a folder. If specified, the path of the objects is
determined relative to this folder. This can be used to specify multiple objects under the same
folder.
-H, --Help - Displays detailed help about the categories of rights available, and the long and
short form of rights names within each category. If a category name is specified, help is
provided for that category.
Stores the ZENworks username and password for use with every command so credentials need
not be entered for every command. The credentials are stored on the home directory of the
logged-in user and are used only for that logged-in user. In Linux, ensure that the user has a
home directory. If you share the same machine login with other ZENworks administrators, you
must clear your credentials by using the
admin-clear-credential
command after you are
finished executing commands.
Batch Command
The batch command is a utility command used to execute a list of zman commands from a text file.
The commands are executed faster because logging into ZENworks is done only once and not for
every command. Batch commands begin with
batch-
short form.
This command accepts the option flags listed in the Global Options section. In addition, it accepts
individual options as listed with the command.
batch-execute (bex) [options] (file path) [...]
Executes zman commands from text files in a batch (not to be confused with Windows batch
files).
(file path) [...] - The path of the text files containing zman commands to be executed. Lines
starting with
sample file, refer to
and // are considered as comments, and are not processed. For a
BatchExecuteCommands.txt
on a Linux server or
server.
Accepts the following option:
in the long form, or with the letter b in the
located in
/opt/novell/zenworks/
on a Windows
-e, --exit-on-failure - Stops executing the commands and exits if a command fails partially or
totally. A command is said to partially fail for commands that take multiple arguments when
the processing of one or more of the arguments was not successful. For example, for
bundle-delete
, the command is said to partially fail if one of the arguments could not be
found or deleted. By default, the commands in the file are executed continuously without
checking for failure.
ZENworks Command Line Utilities15
Bundle Commands
These commands are used to create, modify and manage bundles. Bundle commands begin with
bundle-
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. These commands apply only to
ZENworks 10 Configuration Management.
in the long form, or with the letter b in the short form.
novdocx (en) 16 April 2010
bundle-add-actions (baa) [options] (bundle path) (action XML file) [...]
Adds actions to a bundle.
(action XML file) [...] - The XML files that contain information for actions to be added. The
actions are grouped under one of these action sets: Install, Launch, Verify, Uninstall, Terminate,
Preboot. The XML file contains an
ActionSet
element that contains information of actions to
be added for an action set. Multiple XML files can be given as input to add actions to different
action sets of the bundle. The XML files can be created by exporting actions of an existing
bundle using the
bundle-export-actions
command.
Accepts the following option:
-a, --actioninfo=[content and dependency for actions] - XML file containing content and
bundle dependency information for actions that have file content or dependency on another
bundle. For example, for
content.
Install Bundle Action
Install MSI Action
takes another bundle as dependency so this data also
, the MSI file to be installed is the file
needs to be specified for proper functioning of these actions. For the XML format template,
refer to
bundle-assign (ba) [options] (device or user type) (bundle or bundle group)
(device or user object path) [...]
ActionInfo.xml
on a Linux server or
on a Windows server.
located in
/opt/novell/zenworks/share/zman/samples/
Assigns a bundle or bundle group to one or more device or user objects.
(device or user type) - Valid values are
device, server, workstation
, and
user
.
(device or user object path) [...] - The path of the device or user objects relative to the root
folder of the device or user type specified.
Accepts the following options:
-f, --folder=[bundle folder] - The path of a bundle folder relative to
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
-I, --icon-location=[application location XML file] - XML file that contains the locations to
place the icon for the bundle application. For the XML file format, refer to
-i, --install-immediately - Installs the bundle immediately after distribution.
To use this option, you must also specify the Distribution schedule. The Distribution schedule
can be specified by using the --distribution-schedule, --distribute-now, or --distribute-ondevice-refresh option.
-L, --launch-immediately - Launches the bundle immediately after installation.
To use this option, you must also specify the Distribution schedule. The Distribution schedule
can be specified by using the --distribution-schedule, --distribute-now, or --distribute-ondevice-refresh option.
-n, --distribute-now - Sets the distribution schedule to distribute the bundle immediately. If this
option is specified, the --distribution-schedule and --distribute-on-device-refresh options are
ignored. The --distribute-now, --distribute-on-device-refresh, and --distribution-schedule
options are mutually exclusive and are used to set the distribution schedule. The --distributenow option is considered first, followed by --distribute-on-device-refresh and --distributionschedule.
-r, --distribute-on-device-refresh - Sets the distribution schedule to distribute the bundle on
device refresh. If this option is specified, the --distribution-schedule option is ignored.
-s, --launch-on-device-refresh - Sets the launch schedule to launch the bundle on device
refresh. If this option is specified, the --launch-schedule option is ignored.
-w, --wakeup-device-on-distribution - Wakes up the device by using Wake-On-LAN if it is shut
down while distributing the bundle.
To use this option, you must also specify the Distribution schedule. The Distribution schedule
can be specified by using the --distribution-schedule, --distribute-now, or --distribute-ondevice-refresh option.
-B, --broadcast=[Broadcast address][...] - A comma-separated list of addresses used to
broadcast the Wake-On-LAN magic packets. This option is used only if you choose to wake
up the device by using Wake-On-LAN. A valid IP address is a valid value.
-S, --server=[Path of the Primary or Proxy Server objects relative to
/Devices][...]
- A
comma-separated list of Primary or Proxy Server objects used to wake up the device. This
option is used only if you choose to wake up the device by using Wake-On-LAN.
-C, --retries=[Number of retries] - Number of times the Wake-On-LAN magic packets are sent
to the device(s). This option is used only if you choose to wake up the device by using
Wake-On-LAN. The value must be between 0 and 5. The default value is 1.
-T, --timeout=[Time interval between retries] - The time interval between two retries. This
option is used only if you choose to wake up the device by using Wake-On-LAN. The value
must be between 2 and 10 (in minutes). The default value is 2.
-d, --desc=[description] - Description for the bundle.
-i, --icon-file=[bundle icon file] - The path of the image file containing the image that should be
used as the bundle icon. If this option is not specified, the contents of the subfolders are not
listed.
ZENworks Command Line Utilities17
novdocx (en) 16 April 2010
bundle-create (bc) [options] (bundle name) (bundle XML file) [parent folder]
Creates a new bundle.
(bundle XML file) - XML file containing exported bundle information. Use
to-file (betf
) to export a existing bundle's information into an XML file. If you want to
bundle-export-
reuse files, template XML files can be created from bundles that were created through
ZENworks Control Center. For a sample XML file, refer to
-d, --desc=[description] - Description for the bundle.
-a, --actioninfo=[content and dependency for actions] - XML file containing content and
bundle dependency information for actions that have file content or dependency on another
bundle. For example, for
content.
Install Bundle Action
Install MSI Action
takes another bundle as a dependency. This data also
, the MSI file to be installed is the file
needs to be specified for proper functioning of these actions. For the XML format template,
refer to
Deletes one or more bundle objects.
(bundle object path) [...] - The path of the bundle objects (bundle, bundle folder or bundle
group) relative to
/Bundles
. The wildcard * can be used in the object names if it is enclosed in
quotation marks. Exercise caution while using wildcards for deleting objects.
Accepts the following options:
-r, --recursive - Deletes objects inside a folder recursively.
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
bundle-enable (bel) [options] (bundle path) [...]
Enables bundles.
18ZENworks 10 Configuration Management Command Line Utilities Reference
Accepts the following option:
novdocx (en) 16 April 2010
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
Exports the actions added to a bundle's action set to a file. The file can be used as input to the
bundle-add-actions
command.
(action set type) - The type of the action set. If this option is specified, the actions for only this
action set are listed. Valid values are
Preboot
.
Install, Launch, Verify, Uninstall, Terminate
, and
[action's positions] [...] - A comma-separated list of position of actions in the action set. The
first action is at position 1. Use the
bundle-list-actions
command to see the position of a
particular action in an action set. This is optional, but if it is not specified, all the actions in the
specified action set are exported.
Creates a new folder for containing bundles.
Accepts the following option:
--desc=[description] - Description for the folder.
bundle-group-add (bga) [options] (bundle group path) (bundle path) [...]
Adds bundles to a bundle group.
Accepts the following option:
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
Creates a bundle group and adds members to it.
Accepts the following options:
--desc=[description] - Description for the group.
-m, --members=[bundle path][...] - The path of the bundles relative to
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
/Bundles
.
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
bundle-group-members (bgm) [options] (bundle group path)
Lists members of a bundle group.
ZENworks Command Line Utilities19
Accepts the following option:
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
novdocx (en) 16 April 2010
bundle-group-remove (bgr) [options] (bundle group path) (bundle path) [...]
Removes bundles from a bundle group.
Accepts the following option:
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
Increments the version of bundles.
Accepts the following option:
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
bundle-list (bl) [options] [folder]
Lists bundles objects.
Accepts the following options:
-r, --recursive - Lists results recursively including subfolders. If this option is not specified, the
contents of the subfolders are not listed.
-n, --namefilter=[filter string] - Displays results matching the specified name. The wildcards *
and ? can be used if they are enclosed in quotation marks.
-c, --count - Displays the count of the results.
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
bundle-list-actions (bla) (bundle path) [action set type]
Lists actions added to a bundle.
[action set type] - The type of the action set. If this option is specified, the actions for only this
action set are listed. Valid values are
Preboot
bundle-list-assignments (blas) [options] (bundle or bundle group)
.
Install, Launch, Verify, Uninstall, Terminate
Lists the device and user assignments for a bundle.
Accepts the following options:
-t, --typefilter=[assignment type] - Filters on the assignment type. Valid values are
user
.
device
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
bundle-remove-actions (bra) (bundle path) (action set type) [action's
positions] [...]
Removes actions from a bundle.
, and
and
20ZENworks 10 Configuration Management Command Line Utilities Reference
novdocx (en) 16 April 2010
(action set type) - The type of the action set that contains the action. Valid values are
Launch, Verify, Uninstall, Terminate
, and
Preboot
.
Install
[action's positions] [...] - A comma-separated list of position of actions in the action set. The
first action is at position 1. Use the
bundle-list-actions
command to see the position of a
particular action in an action set. This is optional, but if it is not specified, all the actions in the
specified action set are removed.
bundle-rename (br) (bundle object path) (new name)
Renames a bundle object.
bundle-reorder-actions (broa) (bundle path) (action set type) (current
position) (new position)
Reorders actions in the action set of a bundle.
(action set type) - The type of the action set that contains the action. Valid values are
Launch, Verify, Uninstall, Terminate
bundle-settings-copy (bscp) [options] (source bundle or bundle folder path)
(destination bundle or bundle folder path) [...]
, and
Preboot
.
Install
Copies settings.
(source bundle or bundle folder path) - The path of the bundle or bundle folder relative to
Bundles
from which settings have to be copied.
/
(destination bundle or bundle folder path) [...] - The path of the bundles or bundle folders
relative to
/Bundles
to which settings must be copied.
Accepts the following option:
,
,
-n, --names=[settings name][...] - Names of the settings to be copied from the source path. If
this option is not specified, all settings defined at the source path are copied.
Sets settings at various levels.
(XML file path) - XML file containing exported settings information. Use
(
setf
to-file
) to export settings information into a XML file.
settings-export-
Accepts the following options:
[settings name] [...] - Names of the settings to be exported. If this option is not specified, all
settings are exported.
-f, --force - Forces all children (subfolders and individual bundles) to inherit these settings.
-s, --source=[source bundle or bundle folder path] - The path of the bundle or bundle folder
relative to
/Bundles
for which settings have to be set. If this option is not specified, settings
are set at the Zone level.
bundle-unassign (bua) [options] (device or user type) (bundle or bundle group)
(device or user object path) [...]
Unassigns a bundle or bundle group from one or more device or user objects.
(device or user type) - Valid values are
device, server, workstation
, and
user
.
novdocx (en) 16 April 2010
(device or user object path) [...] - The path of the device or user objects relative to the root
folder of the device or user type specified.
Accepts the following option:
-f, --folder=[bundle folder] - The path of a bundle folder relative to
/Bundles
. If this option is
specified, the path of the bundle objects is determined relative to this folder. This can be used
to specify multiple bundle objects under the same folder.
bundle-update-assignment (bupa) [options] (device or user type) (bundle or
bundle group) (device or user object path) [...]
Updates the assignment between a bundle or bundle group and device or user objects.
(device or user type) - Valid values are
device, server, workstation
, and
user
.
(device or user object path) [...] - The path of the device or user objects relative to the root
folder of the device or user type specified.
Accepts the following options:
-f, --folder=[device or user folder] - The path of the device or user folder relative to the
respective root folder. If this option is specified, the path of the device or user objects is
determined relative to this folder. This can be used to specify multiple device or user objects
with the same folder.
-I, --icon-location=[application location XML file] - XML file that contains the locations to
place the icon for the bundle application. For the XML file format, refer to
-i, --install-immediately=[yes or no] - Install the bundle immediately after distribution, or
true
or
yes
remove the same option set during bundle assignment. Valid values are
false
or no.
, and
-L, --launch-immediately=[yes or no] - Launch the bundle immediately after installation, or
remove the same option set during bundle assignment. Valid values are
false
or no.
true
or
yes
, and
-n, --distribute-now=[yes or no] - Sets the distribution schedule to distribute the bundle
immediately. If this option is specified, the --distribution-schedule and --distribute-ondevice-refresh options are ignored. The --distribute-now, --distribute-on-device-refresh, and
--distribution-schedule options are mutually exclusive and are used to set the distribution
schedule. The --distribute-now option is considered first, followed by --distribute-on-devicerefresh and --distribution-schedule.
-r, --distribute-on-device-refresh=[yes or no] - Sets the distribution schedule to distribute the
bundle on device refresh, or removes the same option set during bundle assignment. Valid
values are
or no. If this option has the value
true
or
yes
, the
true
or
yes
, and
false
--distribution-schedule option is ignored and any previously set distribution schedule is
overwritten.
-s, --launch-on-device-refresh=[yes or no] - Sets the launch schedule to launch the bundle on
device refresh. If this option is specified, the --launch-schedule option is ignored.
-w, --wakeup-device-on-distribution=[yes or no] - Wakes up the device by using Wake-OnLAN if it is shut down while distributing the bundle, or removes the same option set during
true
or
yes
, and
false
bundle assignment. Valid values are
or no.
-B, --broadcast=[Broadcast address][...] - A comma-separated list of addresses used to
broadcast the Wake-On-LAN magic packets. This option is used only if you choose to wake
up the device by using Wake-On-LAN. A valid IP address is a valid value.
-S, --server=[Path of the Primary or Proxy Server objects relative to
/Devices][...]
- A
comma-separated list of Primary or Proxy Server objects used to wake up the device. This
option is used only if you choose to wake up the device by using Wake-On-LAN.
-C, --retries=[Number of retries] - Number of times the Wake-On-LAN magic packets are sent
to the devices. This option is used only if you choose to wake up the device by using
Wake-On-LAN. The value must be between 0 and 5. The default value is 1.
-T, --timeout=[Time interval between retries] - The time interval between two retries. This
option is used only if you choose to wake up the device by using Wake-On-LAN. The value
must be between 2 and 10 (in minutes). The default value is 2.
Displays advanced deployment status of a bundle.
Accepts the following options:
-d, --device=[device path] - Displays the deployment status only for the specified device. The
path of the device is relative to
/Devices
.
-u, --user=[user path] - Displays the deployment status only for the specified user. The path of
the user is relative to
/Users
. If device is also specified, status details for the specified user
logged into the specified device are displayed.
ZENworks Command Line Utilities23
-n, --namefilter=[target device name] - Filters on the name of the device. Displays options
matching the specified filter. The wildcards * and ? can be used if they are enclosed in
quotations.
--statusfilter=[status type][...] - Filters on the status of Bundle Distribution and Install Events.
Valid values are S, F, and P (Success, Failure, and Pending). A comma-separated list of status
types can be given.
-t, --typefilter=[target device or user type][...] - Filters on the type of the target. Valid values are
server, workstation
, and
user
. A comma-separated list of target type can be given.
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
bundle-view-assignment-schedule (bvas) (device or user type) (bundle or bundle
group) (device or user object path)
Displays the deployment schedules for a bundle assigned to a device or user object.
(device or user type) - Valid values are
device, server, workstation
, and
user
.
(device or user object path) [...] - The path of the device or user objects relative to which the
bundle group is assigned.
novdocx (en) 16 April 2010
bundle-view-summary-totals (bvst) (bundle path)
Displays a summary of the deployment status of a bundle.
Certificate Authority Commands
These commands are used to manage the certificate authority role of ZENworks servers. Certificate
authority commands begin with
Imports the key-pair credentials of the zone certificate authority from a file and enables the
Certificate Authority role on the local server.
certificate-authority-role-disable (card)
Disables the Certificate Authority role on the local server.
in the long form, or with the letters ca
certificate-authority-role-enable (care)
Enables the Certificate Authority role on the local server.
Credential Commands
These commands are used to manage the credentials needed for certain ZENworks actions and tasks
that require authentication to resources. Credential commands begin with
cr
form, or with the letters
24ZENworks 10 Configuration Management Command Line Utilities Reference
Backs up the embedded Sybase SQL Anywhere database and also allows you to schedule the
backup operation.
(backup directory) - The local directory on the database server or the network location where
the database files are backed up. Ensure that the parent directory already exists and has
sufficient disk space. Any existing database files in the directory are overwritten.
[schedule SQL file] - File that contains the schedule for backing up the database. The SQL file
can contain CREATE EVENT, ALTER EVENT, or DROP EVENT SQL statements. For
sample SQL files, refer to the files located in
in the long form, or with the letter d in the short form.
/opt/novell/zenworks/share/zman/
on a
ZENworks Command Line Utilities25
Windows server. If you do not specify a schedule file, the database is backed up immediately.
For more information on defining schedules, refer to the SQL Anywhere documentation at
http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.dbdaen10/html/title.htm.
Accepts the following option:
-d, --dir-name=[SQL function call] - SQL function call that returns a value. The value is
appended to the backup directory path. For example, if this command runs on Tuesday with
c:\
the backup directory specified as
DAYNAME(now()), the files are backed up to
and the value for this option specified as
c:\Tuesday
.
novdocx (en) 16 April 2010
database-get-credentials (dgc)
Retrieves the credentials used to connect to the embedded Sybase SQL Anywhere database.
Deployment Commands
These commands are used to perform deployment tasks. Deployment commands begin with
Creates a deployment task to deploy the ZENworks Adaptive Agent to devices by using the IP
address or DNS name.
(user credential file) - The path of the file containing the credentials to connect to the device.
Each line in the file should have a username and password separated by a space. For example,
administrator password.
Accepts the following options:
-f, --file=[IP address file][...] - A comma-separated list of file paths containing the IP addresses
-s, --schedule=[launch schedule XML file] - XML file that contains the launch schedule. For
-r, --run-now - Schedules the deployment task to run immediately after creation.
-b, --reboot=[Reboot option] - Indicates when the device must be rebooted after deploying the
-d, --desc=[description] - Description for the deployment task.
-p, --proxy=[Windows Proxy] - The path of a Windows device relative to
in the long form, or with the letters dp in the short form.
or DNS names of devices to which the ZENworks Adaptive Agent should be deployed. The
file can contain a list of IP addresses or DNS names of devices in comma-separated-value
(CSV) format, or one IP address or DNS name on each line.
the schedule XML file templates, refer to the XML files located in
. In order
to deploy management agents to Microsoft Windows devices from a Linux Primary Server, a
managed device running Microsoft Windows is needed. Ignore this option if you are running
the deployment task from a Windows Primary Server.
26ZENworks 10 Configuration Management Command Line Utilities Reference
-t, --timeout=[Time out] - The number of seconds you want the Primary Server to wait for a
response from the Windows Proxy.
-k, --key=[Registration key] - Registration key for registering the device.
Lists the deployment tasks and the status.
Accepts the following options:
-n, --namefilter=[filter string] - Displays results matching the specified name. The wildcards *
and ? can be used if they are enclosed in quotations marks.
-c, --count - Displays the count of the results.
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
Schedules the specified deployment task to run immediately. The task should have the
credentials saved in the data store.
Discovery Commands
These commands are used to view device discovery-related information. Discovery commands
begin with
discovery-
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.
in the long form, or with the letter d in the short form.
. If this option is not specified, all devices are displayed.
-m, --management-status=[management status] - Displays devices having the specified status.
Valid values are
discovered, inventoried, managed
, and
retired
. If this option is not
specified, all types of devices are displayed regardless of their status.
--modefilter=[discovery mode] - Displays the devices discovered by using the specific
discovery mode. Valid values are
migration
. If this option is not specified, all devices are displayed.
IP, LDAP, csvimport, ZENworks-migration
, and
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
discovery-task-list (dtl) [options]
Lists the discovery tasks and the status.
,
ZAM-
ZENworks Command Line Utilities27
Accepts the following options:
-n, --namefilter=[filter string] - Displays results matching the specified name. The wildcards *
and ? can be used if they are enclosed in quotation marks.
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
Lists the dynamic groups.
Accepts the following options:
(device type) - Valid values are
server
and
workstation
[folder] - Lists the content of the specified folder. If it is not specified, the content of the root
folder is displayed.
[-n|--namefilter=filter string] - Displays the results matching the specified name. The wildcards
* and ? can be used if they are enclosed in quotation marks.
[-s|--scrollsize=scroll size] - Number of results to be displayed at a time.
[-r|--recursive] - Lists the results recursively, including subfolders. If it is not specified, the
contents of subfolders are not listed.
[-c|--count] - Displays the count of the results.
in the long form, or with the letters dg in
.
dynamic-group-members (device type) (dynamic group name) [path of the dynamic
group folder] [-s|--scrollsize=scroll size]
Lists the members of the specified dynamic group.
Accepts the following options:
(device type) - Valid values are
server
and
workstation
.
(dynamic group name) - Name of the dynamic group.
[path of the dynamic group folder] - The path of the dynamic group. You can specify either the
complete path or the relative path of the root folder.
[-s|--scrollsize=scroll size] - Number of results to be displayed at a time.
dynamic-group-refresh (device type) [(dynamic group name) (dynamic group name)
... (dynamic group name)] [-f|--folder=folder name including path of the
dynamic group folder] [-a|--all]
Refreshes the specified dynamic group.
Accepts the following options:
(device type) - Valid values are
server
and
workstation
.
(dynamic group name) - Name of the dynamic group. You can list multiple groups.
28ZENworks 10 Configuration Management Command Line Utilities Reference
[-f|--folder=folder name including path of the dynamic group folder] - Dynamic group folder’s
name, including its full path.
[-a|--all] - Refresh all existing dynamic groups.
Hotlist Command
This command is used to view the list of devices that have unacknowledged warnings or errors. The
Hotlist
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.
command begin with
hotlist-
in the long form, or with the letter
hl
in the short form.
novdocx (en) 16 April 2010
hotlist-view (hlv) [options]
Lists devices that have unacknowledged warnings or errors.
Accepts the following options:
-c, --count - Displays only the count of the hotlist items.
-t, --type=[error type] - Filters on the error type of hotlist items. Valid values are
Noncompliant, Critical
, and
Warning
.
-o, --operator=[comparison operator] - If specified, this operator is used in error-count-based
filtering. Valid values are >, >=, =, <, and <=. Enclose the operators in double quotation
marks so that > and < are not considered by the system as redirection operators.
-e, --errorcount=[erorr count] - Filter by the count of the error type specified. If the comparison
>=
operator is not specified , the
is used by default. If error type is not specified, the count is
taken as the sum of noncompliant, critical and warning errors.
-s, --scrollsize=[scrollsize] - Number of results to be displayed at a time.
Warning or errors can be acknowledged by using the
messages-acknowledge
command.
When all warnings or errors for a device are acknowledged the messages no longer appear on
the hotlist.
Imaging Commands
These commands are used to perform Imaging operations. Imaging commands begin with
in the long form, or with the letter i in the short form.
Applies the most effective Imaging bundle.
Accepts the following options:
(Device type) - Valid values are
server
and
workstation
.
(Device name) - Name of the server or workstation object.
For example, to apply the assigned Imaging bundle to a server with the name server1, run the
following command:
zman iaaib server server1
If the device object is located within a folder, use the following the command:
iaaib (Device type) (folder/path of device)/(Device name)
ZENworks Command Line Utilities29
where
folder/path of device
Server
folder.
is the relative path of the device within the
Workstation
If you have multiple workstations in a directory, and the name of the workstations is prepended
by common alphanumeric characters (for example, dev091, dev092,...dev099), use the
following command from a Linux server to simultaneously apply the assigned imaging bundle
on multiple devices:
Sends the inventory data collection form to one or more devices.
in the long form, or with the letter i
novdocx (en) 16 April 2010
or
Accepts the following option:
-f, --folder=[device folder] - The path of the device folder relative to
/Devices
. If this option is
specified, the path of the device objects is determined relative to this folder. This option can
be used to specify multiple device objects under the same folder.
Initiates an inventory scan of one or more devices.
Accepts the following option:
-f, --folder=[device folder] - The path of the device folder relative to
/Devices
. If this option is
specified, the path of the device objects is determined relative to this folder. This option can
be used to specify multiple device objects under the same folder.
License Commands
These commands are used to activate your ZENworks server or to display licensing information.
License commands begin with
license-
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.