ZfS Console Commands

The following table lists the ZfS server console commands with short descriptions of the commands. The table also indicates at which server console prompt a command can be given.

The column heading M is for the server's main console prompt, Z for the ZfS prompt, and T for the TED prompt. Under a console prompt column, a Y indicates that the command can be issued at that prompt and a - indicates that the command cannot be issued at that prompt.

Command M Z T Description

HELP

Y

Y

Y

Displays a list of available commands. Only the commands applicable to a component will be displayed.

HELP command

Y

Y

Y

Displays help for the specified command.

CLS

Y

Y

Y

Clears the screen. Useful for quickly recognizing which information is new when you type a command.

DOWN option

Y

Y

-

This is similar to the command used on the server's main console prompt. However, if you use DOWN at the ZfS prompt, server policy settings for downing the server will be followed.

For the ZfS prompt, this command has several options:

  • DOWN SERVER: Downs the server only; does not bring it back up.

  • DOWN STATUS: Displays the current down status.

  • DOWN RESTART: Downs the server, then restarts it.

  • DOWN RESET: Downs the server, then resets it.

  • DOWN CANCEL: Allows you to cancel the down, up to when the server is actually taken down. This will not leave the server in an unusable state.

  • DOWN !: Causes the down process to execute immediately, ignoring the Down Server Process policy that can be in effect.

EVENTS option

-

Y

-

The command has three options:

  • EVENTS LIST: Lists all registered events, including third-party events.

  • EVENTS STATUS: Gives the status of each event.

  • EVENTS FIRE event_ID: Allows you to manually run an event.

EXIT

-

Y

-

Closes the current command prompt's Java* software. For example, if given at the Subscriber prompt, the Subscriber's Java software is closed.

EXITALL

-

Y

-

Closes the current command prompt's Java and native software.

LISTPLUGINS

-

Y

-

Lists the current ZfS plug-ins.

PACKAGE option

-

Y

-

You can do the following for the software packages installed on the server:

  • PACKAGE LIST: Lists the currently installed software packages. This is useful for knowing which packages can be rolled back and the order that they'll be rolled back, which is the reverse order in which they finished installing, not the order they started installing.

  • PACKAGE PROCESS full_package_path: Use this to manually install a software package.

  • PACKAGE ROLLBACK: Automatically rolls back (uninstalls) the most recently installed software package. For example, you installed three software packages on a server (Package1, Package2, and Package3), and Package1 was installed first, Package2 second, and Package3 last. If you want to roll back Package2, you need to first roll back Package3. To do so, type  package rollback  at the server console once for Package3, then again for Package2.

    The software package installation order is not guaranteed, because the order is determined by when a package has finished processing. Therefore, the installation order might be Package2, Package1, Package3 when using the Package Rollback command. This order is shown by the Package List command.

POLICY
or
POLICY LIST

-

Y

-

Lists the effective server policies. Each policy listed has a corresponding policy number for reference when using the POLICY ENFORCE command.

POLICY ENFORCE policy_number

-

Y

-

Used to manually enforce a specific policy. The policy_number can be found using the POLICY LIST command.

This is useful for enforcing a policy ahead of its schedule. However, you will usually use POLICY REFRESH first to ensure you are enforcing the most recent changes.

POLICY ENFORCE ALL

-

Y

-

Used to manually enforce all effective policies, such as after doing a POLICY REFRESH.

POLICY EVENTBASED

-

Y

-

Lists the event-based policies.

POLICY PLUGINS

-

Y

-

Lists the current policy enforcers and the current event handlers.

POLICY REFRESH

-

Y

-

Refreshes only the server's policies and schedules, as required (unlike the REFRESH command, which refreshes policies and undoes any changes made to the prompts).

After using this command, you should do a POLICY ENFORCE.

POLICY REFRESHONLY

-

Y

-

Refreshes the server's policies, but does not schedule effective policies.

POLICY RESCHEDULEONLY

-

Y

-

Reschedules all current policies according to their schedules. Does not refresh the effective policies.

POLICY SCHEDULES

-

Y

-

Lists all policy schedules that are in effect.

PROMPT

-

Y

Y

Temporarily resets the current prompt. It will revert back to whatever is specified in the Novell eDirectoryTM object for the console prompt when the Java process is exited or restarted, or when the REFRESH command is given.

REFRESH

-

Y

-

Manually forces a refresh of a policy, including pending changes to service locations for the current server and temporary changes to ZfS prompts.

IMPORTANT:  Do not refresh the Distributor more often than every five minutes. The following can need up to five minutes to complete their processes: Distribution building, eDirectory replication, and tree walking (when no Search policy is defined).

Used alone, it refreshes only the ZENworks for Servers policy. Use POLICY REFRESH to refresh all policies.

Also restarts the current component's Java process by running the DIST.NCF or SUB.NCF file.

You can use this to restart Java as well, because these Java processes will restart Java when they are run.

Note that changes to TED object properties are not in effect until the related Distributor re-reads eDirectory.

SETCONSOLELEVEL number

-

-

-

Sets the console message level:

0: No messages

1: Errors

2: Successes & level 1 messages

3: Warnings & level 2 messages

4: Information & level 3 messages

5: Trace information & level 4 messages

6: Developer trace information & level 5 messages

SETFILELEVEL number

-

Y

Y

Sets the file message level:

0: No messages

1: Errors

2: Successes & level 1 messages

3: Warnings & level 2 messages

4: Information & level 3 messages

5: Trace information & level 4 messages

6: Developer trace information & level 5 messages

SHOWSCHEDULE

-

Y

-

Lists the current schedules.

SHOWVARS

-

Y

-

Lists the predefined variables and their values. These variables can be used in Server Software Packages.

STATUS

-

Y

-

Lists the current status of Policy and Distribution Services, including:

Base Path
Plug-ins Loaded
Events Registered
Scheduled Items
Console Level

TIME

Y

Y

Y

Returns the current date and time that the server is set to.

VERSION

Y

Y

Y

Returns the ZfS version for the ZfS and TED prompts, and the NetWare version for the console's main prompt.