zac for Macintosh (1)

Name

zac - The command line management interface for the Micro Focus ZENworks Agent that is installed and running on Macintosh managed devices.

Syntax

zac command options

Description

The zac utility performs command line management functions on the ZENworks managed device, including installing and removing software bundles, applying policies, and registering and unregistering the device.

Guide to Usage

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

Most commands have a long form and a short form:

  • Long form: add-reg-key
  • Short form: ark

When both forms are available, the command is listed as follows:

add-reg-key (ark) options

When using the command, enter only the long form or the short form:

zac add-reg-key options

zac ark options

If an option includes a space, enclose it in quotation marks:

zac ark "option 1"

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:

zman server-add-bundle [options] (server) (bundle) [...]

The ellipsis indicates that server-add-bundle can accept multiple bundles. In the command level help, the multiple entry argument help is given as [(bundle) (bundle) ... (bundle)] for more clarity.

Bundle Commands

bundle-install (bin)

Installs the specified bundles based on the display name that match the specified regular expression or string, or the bundle GUID.

Use the bundle-list command to get a list of the available bundles and their display names.

An example to install a bundle:

zac bin MacBundle

bundle-launch (bln)

Launches the specified bundle. The actions in the Launch Action set are executed. If you try to launch a bundle that is not installed, the bundle is first installed and then launched.

Use the bundle-list command to get a list of the available bundles and their display names.

An example to launch a bundle based on the display name:

zac bln MacBundle

bundle-list (bl)

Displays the list of bundles assigned to the device and the logged-in user.

The output of this command is displayed in columns and provide the details of every bundle assigned or available for the managed device. The Display Name, Version, and Bundle Type columns represent the bundle display name, the version number of the bundle or sandbox if the bundle is a sandbox version, and the bundle type, respectively.

The Status column displays the following states:

Available: Displays this state if the bundle is installed.

Not Installed: Displays this state if the particular bundle version is not installed.

Downloaded: Displays this state if the contents are downloaded but the action in the InstallAction set have not been executed.

An example to list all the bundles:

zac bl

bundle-lock-add (bla) [options] [bundlename] [...]

Locks the specified bundles that match the specified regular expression or string from being upgraded or removed.

Bundle locks are applicable only for Install action set.

Accepts the following options:

-li, --lock-install - Locks the bundle and prevents the installation of the bundle that is specifiedin the lock.

-t, --type - Specify the bundle type to be locked. The available types are mac and patch. If no type is specified, the type, bundle, is selected.

bundle-lock-list (bll)

Lists the bundle locks. The bundle locks are sorted by ID number.

An example to list the locked bundles:

zac bll

bundle-lock-remove (blr)

Removes the bundle lock that you specify by its number. You can find the number for each lock by using the bundle-lock-list command.

An example to remove all bundle locks:

zac blr --remove-all

bundle-props (bp)

Returns property information for a bundle.

An example to get the bundle properties of a specified bundle:

zac bp MacBundle

bundle-refresh (br)

Refreshes information about the specified bundle.

An example to refresh a bundle:

zac br MacBundle

bundle-search (bse)

Searches for bundles matching the specified java regular expression or string.

bundle-uninstall (bu)

Uninstalls the specified bundle. The actions that support the Undo action are executed while uninstalling the bundle. After the bundle uninstall is complete, the bundle state is displayed as Not Installed.

Use the bundle-list command to get a list of the installed bundles and their display names.

An example to uninstall a bundle:

zac bu MacBundle

bundle-verify (bv)

Reinstalls the bundle and executes the Verify action sets to ensure that no files have been removed or corrupted. Use the bundle-list command to get a list of the installed bundles and their display names.

An example to verify a bundle:

zac bv MacBundle

Core Commands

add-reg-key (ark)

This command registers a device by using the specified registration key.

Example: zac add-reg-key

agent-properties (agp)

This command provides information about the ZENworks Agent.

Example: zac agent-properties

cache-clear (cc)

Clears the cache on this device.

Example: zac cc

cert-info (ci)

Lists public key certificate information for each known ZCM server or adds a trusted root certificate to the machine store.

Example:

To list the certificate for each known ZENworks user:

zac ci

To add a trusted root certificate to the devices trusted store:

zac ci c:\certs\mytrustcacert.der -u myuser -p mypassword

config-location (cl)

Displays the current location.

Example:

zac config-location

file-system-guid (fsg)

Removes and restores the workstation GUID in the file system in preparation for taking an image.

Example:

zac fsg

get-pref (get)

Displays the preferences that are currently set.

Example to display all preferences that have names beginning with abc:

zac get-pref abc

get-settings (gs)

Returns the effective settings associated with the given key.

Example to list the Remote Management settings:

zac gs RemoteManagement

logger (log)

This command changes the logger configuration.

Example to reset the log file:

zac logger resetlog

reestablish-trust (retr)

This command re-establishes trust with the current zone.

Reestablishes trust with the current Management Zone. The username and password used must be of the Zone Administrator.

Example:

zac retr -u myuser -p mypassword

The -u and -p parameters are optional. If you don’t use the -u and -p parameters, you are prompted to enter a username and password.

refresh (ref)

This command triggers a refresh of the specified type.

register (reg)

This command registers a device to a specified zone.

To execute this command you must have Create/Delete device rights for the folder on which the device you are attempting to register.

Example:

zac reg -k key1 https://123.456.78.90

reregister (rereg)

This command registers a device in the current zone and assigns it to the GUID of an existing device object. The currently associated device object is deleted. To execute this command you must have Create/Delete device rights for the folder on which the device you are attempting to reregister.

To reregister, specify a username and password:

zac reregister -u myuser -p mypassword eaa6a76814d650439c648d597280d5d4

set-pref (set)

Sets the value for a preference.

Example to set the value of preference abc to 123:

zac set-pref abc 123

set-proxy (sp) [options] <IP address/Hostname:port> [username] [password]

Specifies a proxy to contact rather than contacting a ZENworks Server directly.

The options are:

  • /default - Sets a proxy that can be overriden by proxy settings from the Management Zone.
  • /clear - Clears the current proxy, but will use proxy settings from the Management Zone.
  • /ipv6 - sets an IPv6 proxy.

Examples:

IPv4:

zac sp 123.456.78.90:2349 administrator novell

zac sp /default 123.456.78.90:2349

zac sp /clear

IPv6:

zac sp /ipv6 [2001:db8:0:1:1:1:1:1]:2349 administrator novell

zac sp /default /ipv6 [2001:db8:0:1:1:1:1:1]:2349

zac sp /clear /ipv6

If a username and password is not specified, then you will be prompted to enter them.

unregister (unr)

This command unregisters a device from the current zone.

To execute this command you must have Create/Delete device rights for the folder on which the device you are attempting to unregister

Example:

zac unr -u administrator -p novell

NOTE:Running UNR command might cause high utilization of the database. This might be due to any of the following reasons:

  • The UNR command is running on the server.

  • The zone contains large number of managed devices.

  • The managed devices have a huge history.

  • The Patch Management is enabled.

zone-config (zc)

This command displays the Zone Configuration server or lists the current zone configuration.

zac zc

Inventory Commands

inventory (inv) [scannow]

Runs an inventory scan.

An example to run an inventory scan:

zac inv scannow

Inventory-Only Commands

These commands are used only for Inventory-Only (IOA) agents.

zac ioa cfg <server ip>

Configures the MAC IOA device to the mentioned server ip.

An example to register a MAC Inventory-Only device to the server <10.70.13.124>

zac ioa cfg 10.70.13.124

zac ioa version

Displays the version of the Inventory-Only (IOA) agent.

inventory (inv) [scannow]

Runs an inventory scan.

An example to run an inventory scan:

zac inv scannow

Patch Management Commands

patch-scan (ps)

Scans the device for patches that are not applied, using the device's current patch signature (DAU) file. The results are then uploaded to the server.

An example to run a patch scan:

zac ps

patch-scan --quick (ps --quick)

Uploads the last scan results to the server; it does not run a new detection scan.

An example to run a quick patch scan:

zac ps --quick

patch-apply-policy (pap)

Updates devices with the latest version of all patch policies.

An example to run a patch apply policy:

zac pap

patch-quarantine-release (pqr)

Releases any quarantined patches on the device where the command is run from quarantine so that a one-time installation attempt can occur, either from a patch policy schedule or a remediation schedule.

An example to run a patch quarantine release:

zac pqr

Satellite Roles Commands

satellite-cachecfg (satcfg)

Reads Satellite roles from cache.

An example to read Satellite roles from cache:

zac satcfg

satellite-clearcache (satcc)

Clears Satellite configuration information from cache.

An example to clear Satellite configuration information from cache:

zac satcc

satellite-refreshcfg (satrc)

Refreshes Satellite roles.

An example to refresh Satellite roles:

zac satrc

satellite-roles (satr)

Reports on current Satellite roles and their state.

An example to report on current Satellite roles and their state:

zac satr

Status Commands

zenhttp-status(zhs)

Lists port and tags for registered handlers.

An example to list port and tags for registered handlers:

zac zhs

This command is applicable only if the agent is promoted as a satellite.

Location Commands

location-create (lc) (location name) [-d|--desc=<description>] [network environment name] [...]

Creates a location and (optionally) assigns network environments to the location.

(location name) - The name you want assigned to the new location.

[network environment name] - The name of an existing network environment that you want to assign to the location. You can add multiple network environments. Adding network environments during creation of a location is optional. You can use the location-nwenv-assign command to add network environments after creation.

[network environment name] - The name of an existing network environment that you want to assign to the location. You can add multiple network environments. Adding network environments during creation of a location is optional. You can use the location-nwenv-assign command to add network environments after creation.

Accepts the following options:

-d |--desc=description: Specify a description for the location.

-t | -- downloadThrottle=Download Throttle rate: Specify a download throttle rate.

-u | -- uploadThrottle=Upload Throttle rate Specify an upload throttle rate.

-a | -- auditUpload=Audit upload data Specify 0 to enable or 1 to disable the audit upload data.

-e | -- Preferred protocol for communication Based on your preferred protocol for communication, specify either IPv4 or IPv6.

Specify IPv4 if you want the devices in this location to try communicating with the servers using IPv4 URLs first before attempting IPv6 URLs.

Specify IPv6 if you want the devices in this location to try communicating with the servers using IPv6 URLs first before attempting IPv4 URLs.

C | -- cifsServer=CIFS Server: Specify a CIFS server that allows you to provide share access.

-i | --proxyAddress=IPv4 HTTP Proxy Address Specify an IPv4 proxy address.

-p | --proxyPort= IPv4 HTTP Proxy Port: Specify the port number on which the proxy server should listen.

-r | --proxyCidr=IPv4 HTTP Proxy CIDR: Specify the range of IPv4 address using CIDR notation.

-x | --ipv6ProxyAddress=IPv6 HTTP Proxy Address Specify an IPv6 proxy address

-y –ipv6ProxyPort=IPv6 HTTP Proxy Port: Specify the port number on which the proxy server should listen.

-z | -- ipv6ProxyCidr=IPv6 HTTP Proxy CIDR: Specify the range of IPv6 address using CIDR notation.

(location preferred protocol communication | lppc) <location name> [options]

Edits an existing location.

<location name>: Specify a name for the location.

Accepts the following options:

IPv4: Specify IPv4 if you want the devices in this location to try communicating with the servers using IPv4 URLs first before attempting IPv6 URLs.

IPv6: Specify IPv6 if you want the devices in this location to try communicating with the servers using IPv6 URLs first before attempting IPv4 URLs.

System Update Commands

zac zeus-refresh / zeus-ref

Retrieves the system update when it is assigned to a device.