-
Cisco Unity Express Command Reference for 3.0 and Later Versions
-
Using Cisco Unity Express Software
-
Cisco Unity Express Commands: A
-
Cisco Unity Express Commands: B
-
Cisco Unity Express Commands: C
-
Cisco Unity Express Commands: D
-
Cisco Unity Express Commands: E
-
Cisco Unity Express Commands: F
-
Cisco Unity Express Commands: G
-
Cisco Unity Express Commands: H
-
Cisco Unity Express Commands: I
-
Cisco Unity Express Commands: K
-
Cisco Unity Express Commands: L
-
Cisco Unity Express Commands: M
-
Cisco Unity Express Commands: N
-
Cisco Unity Express Commands: O
-
Cisco Unity Express Commands: P
-
Cisco Unity Express Commands: R
-
Cisco Unity Express Commands: script (ccn application) to show ccn trigger sip
-
Cisco Unity Express Commands: show clock detail to show remote users
-
Cisco Unity Express Commands: show restore history to system shutdown (aaa accounting enable)
-
Cisco Unity Express Commands: T
-
Cisco Unity Express Commands: U
-
Cisco Unity Express Commands: V
-
Cisco Unity Express Commands: W
-
Cisco Unity Express Commands: X
-
Cisco Unity Express Commands: Z
-
Index
-
Feedback
Table Of Contents
B
Last Updated: March 31, 2011
backup
To set the backup parameters, use the backup command in Cisco Unity Express configuration mode. To delete the number of revisions or the backup server URL, use the no form of this command.
backup {revisions number | server url ftp-url username ftp-username password ftp-password}
no backup {revisions number | server url ftp-url}
Syntax Description
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Set these parameters before backing up any files.
Consider the amount of storage space that each backup file requires when setting the number of files to store. When the number is reached, the next backup file overwrites the oldest stored backup file.
The system automatically numbers and dates the backup files and identifies the revision number in a backupid field. Reference this backup ID value when restoring a file.
Performing different backup types at various times causes different backup IDs for data backups and configuration backups. For example, the last data backup ID might be 3 and the last configuration backup might be 4. Performing an all backup might result in a backup ID of 5 for both data and configuration. See the backup category command for information about different backup types.
For secure FTP, the URL is of the form sftp://...
Examples
The following example sets 7 revisions on FTP server /branch/vmbackups.
se-10-0-0-0> enablese-10-0-0-0# config tse-10-0-0-0(config)# backup revisions 7se-10-0-0-0(config)# backup server url ftp://branch/vmbackups username admin password mainserverThe following example sets 5 revisions on a secure FTP server /vmbackups.
se-10-0-0-0> enablese-10-0-0-0# config tse-10-0-0-0(config)# backup revisions 7se-10-0-0-0(config)# backup server url sftp://vmbackups username admin password mainserverRelated Commands
Specifies the type of data to be backed up.
Displays statistics for backed-up files.
Displays the FTP server designated to store backup files.
backup categories
To specify which categories of data to backup for scheduled backups, use the backup categories command in Cisco Unity Express scheduled backup configuration mode.
backup categories [all] [configuration] [data] [HistoricalData] [TimeCardView]
Syntax Description
all
Backup all categories of data.
configuration
Backup configuration data.
data
Backup data.
HistoricalData
Backup historical data.
TimeCardView
Backup data for the Time Card View application
Command Default
None.
Command Modes
Cisco Unity Express scheduled backup configuration (backup-schedule)
Command History
Usage Guidelines
You can specify multiple categories of data. This command applies to scheduled backups only. To set categories for non-scheduled backups, see the backup category command.
Examples
The following example specifies that only configuration data will be backed up in the scheduled backup:
se-10-0-0-0# config t
se-10-0-0-0(config)# backup schedule
Your new JOB ID is 22
se-10-0-0-0(backup-schedule)# backup categories configuration
Related Commands
Enters backup-schedule submode.
Shows details for the specified recurring scheduled backup job.
backup category
To specify the type of data to be backed up, use the backup category command in Cisco Unity Express offline mode.
backup category {all | configuration | data}
Syntax Description
all
Backs up all data.
configuration
Backs up only system and application settings.
data
Backs up only voice-mail messages and application data.
Defaults
All data is backed up.
Command Modes
Cisco Unity Express offline
Command History
Usage Guidelines
This command indicates the type of Cisco Unity Express data to be backed up to the FTP server.
When the backup procedure begins, all active calls are terminated. In Version 1.0, Cisco Unity Express does not support scheduled restores. Consider doing the backup procedure when the telephones are least active.
Examples
The following examples illustrate all the backup categories:
se-10-0-0-0> enablese-10-0-0-0# offline!!!WARNING!!!: Putting the system offline will terminate all active calls.Do you wish to continue[n]? : yse-10-0-0-0(offline)# backup category allse-10-0-0-0(offline)# continuese-10-0-0-0#se-10-0-0-0> enablese-10-0-0-0# offline!!!WARNING!!!: Putting the system offline will terminate all active calls.Do you wish to continue[n]? : yse-10-0-0-0(offline)# backup category configurationse-10-0-0-0(offline)# continuese-10-0-0-0#se-10-0-0-0> enablese-10-0-0-0# offline!!!WARNING!!!: Putting the system offline will terminate all active calls.Do you wish to continue[n]? : yse-10-0-0-0(offline)# backup category datase-10-0-0-0(offline)# continuese-10-0-0-0#Related Commands
Activates the backup or restore process.
Initiates Cisco Unity Express offline mode.
Displays details about backed-up files.
Displays details about the backup server.
backup notification
To configure the system to notify users about the scheduled backup status, use the backup notification command in Cisco Unity Express backup-schedule configuration mode. To disable the backup notification, use the no form of this command.
backup notification on {success | failure | always} {voicemail user_id | email email_address | epage epage_address}
no backup notification on {success | failure | always } {voicemail user_id | email email_address | epage epage_address}Syntax Description
Defaults
No default.
Command Modes
Cisco Unity Express backup-schedule configuration
Command History
Usage Guidelines
This command can be entered multiple times to add more notification targets, with a maximum of three targets for each kind (voicemail, email or epage).
Examples
The following example configures multiple targets to be notified of the scheduled backup status.
se-10-0-0-0# backup schedule 22se-10-0-0-0(backup schedule)# backup notification always email sysadmin@digg.comse-10-0-0-0(backup schedule)# backup notification on failure email e@ciscose-10-0-0-0(backup schedule)# backup notification always pager email2@comse-10-0-0-0(backup schedule)# backup notification always voicemail adminRelated Commands
Displays details about backed-up files.
Shows all configured recurring scheduled backup jobs.
backup schedule
To configure a one-time or recurring scheduled backup, use the backup schedule command in Cisco Unity Express configuration mode. Use the no form of this command to remove the configuration of the backup job.
backup schedule [name]
no backup schedule name
Syntax Description
Command Default
None.
Command Modes
Cisco Unity Express EXEC mode
Command History
Usage Guidelines
This command enters backup-schedule mode and enables you to configure one-time or recurring backup jobs.
If you do not provide a name when you enter the command, one is automatically selected and displayed. If the maximum number of schedules reached and the system is unable to create the scheduled backup job using the specified parameters, an error message is display.
To create a one time backup job, enter the time of day and the date as input.
For recurring backup jobs, you can configure the jobs to repeat:
•
Every N days at a specific time
•
•
•
You can also configure the following parameters for backup jobs:
•
•
Examples
The following example configures a a scheduled backup to occur every 7 days at 11:00pm:
se-10-0-0-0# backup schedule
Your new JOB ID is 22
se-10-0-0-0(backup-schedule)# repeat every 7 days at 23:00
Related Commands
Specifies how often a recurring scheduled backup occurs.
Shows all configured recurring scheduled backup jobs.
backup schedule disable all
To disable all scheduled backups, use the backup schedule disable all command in Cisco Unity Express backup-schedule configuration mode. Use the no form of this command to reenable all scheduled backups.
backup schedule disable all from date to date
no backup schedule disable all
Syntax Description
Command Default
None.
Command Modes
Cisco Unity Express EXEC mode
Command History
Usage Guidelines
The format for the date is month, day, and then year (for example: 05/302010).
Examples
The following example disables all scheduled backups from July 6, 2010 to July 8, 2010:
se-10-0-0-0# backup schedule disable all from 07/06/2010 to 07/08/2010
Related Commands
Specifies how often a recurring scheduled backup occurs.
Shows all configured recurring scheduled backup jobs.
backup security enforced
To specify that only protected and untampered backup files can be restored, use the backup security enforced command in Cisco Unity Express configuration mode.
backup security enforced
Syntax Description
This command has no arguments or keywords.
Command Default
All of the following types of backup files are restored:
•
•
•
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Before you can use this command, you must generate a backup security key by using the backup security key generate command.
Use the backup security enforced command in Cisco Unity Express configuration mode to specify that only protected and untampered backup files can be restored. By default, the system also restores unprotected (clear) backup files as well, as protected backup files and untampered backup files.
Examples
The following example specifies that only protected and untampered backup files can be restored:
se-10-0-0-0# config tse-10-0-0-0(config)# backup security enforced
Related Commands
Creates or deletes the master key used for encrypting and signing the backup files.
Enables secure mode for backups.
backup security key
To create or delete the master key used for encrypting and signing the backup files, use the backup security key command in Cisco Unity Express configuration mode.
backup security key {generate | delete}
Syntax Description
Command Default
No key is configured.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Use the backup security key command in Cisco Unity Express configuration mode to create or delete the master key used for encrypting and signing the backup files. When creating a backup security key, you are prompted to enter the password from which the key will be derived.
This command will not be saved in the startup configuration when you use the write command.
Examples
The following example creates a master key:
se-10-0-0-0# config tse-10-0-0-0(config)# backup security key generate
Please enter the password from which the key will be derived: ******
The following example deletes a master key:
se-10-0-0-0# config tse-10-0-0-0(config)# backup security key delete
You have a key with magic string cfbdbbee
Do you want to delete it [y/n]?:
Related Commands
Specifies that only protected and untampered backup files can be restored.
Enables secure mode for backups.
backup security protected
To enable secure mode for backups, use the backup security protected command in Cisco Unity Express configuration mode.
backup security protected
Syntax Description
This command has no arguments or keywords.
Command Default
Backup files are stored in unprotected mode on the remote server.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Before using this command, you must generate backup security key by using the backup security key generate command.
Use the backup security protected command in Cisco Unity Express configuration mode to enable secure mode for backups. In secure mode, all backup files are protected using encryption and a signature.
Examples
The following example enables secure mode for backups:
se-10-0-0-0# config tse-10-0-0-0(config)# backup security protected
Related Commands
Specifies that only protected and untampered backup files can be restored.
Creates or deletes the master key used for encrypting and signing the backup files.
backup server authenticate
To retrieve the fingerprint of the backup server's host key, use the backup server authenticate command in Cisco Unity Express configuration mode.
backup server authenticate
Syntax Description
This command has no arguments or keywords.
Command Default
This command has no default value.
Command Modes
Cisco Unity Express configuration
Command History
Usage Guidelines
Use the backup server authenticate command in Cisco Unity Express configuration mode to retrieve the fingerprint of the backup server's host key. Before using this command, users must configure the backup server URL and the login credential. The backup server URL must start with "sftp://." After the fingerprint is retrieved from the backup server, the system prompts the user for confirmation.
If this command is accepted, the fingerprint is stored in the form of "backup server authenticate fingerprint fingerprint-string" in the running configuration.This command will not be saved in the startup configuration when you use the write command.
Examples
The following example retrieves the fingerprint of the backup server's host key:
se-10-0-0-0# config tse-10-0-0-0(config)# backup server authenticate
The fingerprint of host 10.30.30.100 (key type ssh-rsa) is:
a5:3a:12:6d:e9:48:a3:34:be:8f:ee:50:30:e5:e6:c3
Do you want to accept it [y/n]?
Related Commands
banner login
To configure the login banner, use the banner login command in Cisco Unity Express EXEC mode. Use the no or default form of the command to remove the login banner.
banner login {delimiter-char banner-content delimiter-char | append}
no banner login
default banner login
Syntax Description
delimiter-char
Character that indicates the beginning and end of the banner text.
banner-content
Text content of the banner.
append
Appends additional text to the banner.
Command Default
No login banner is configured.
Command Modes
Cisco Unity Express EXEC
Command History
Usage Guidelines
This command configures a system wide login banner that is displayed to all users when they log in. This command requires a delimiter character that signals the end of banner content input. The delimiter character can be any printable character except ? and ". The delimiter character must not occur in the banner content or the banner input will be ended prematurely. The banner contains plain text (no special formatting) and can have up to 1944 characters (including new lines). You can enter multiline input as the banner content.
The banner command is a multi-line command. The banner-content can be one or more lines. You can include the following tokens in the banner-content to represent system settings.
$(hostname)
Displays the hostname for the module.
$(domain)
Displays the domain for the module.
If you enter a banner that exceeds the allowed length, the command stops accepting input, truncates the message at the maximum length, outputs an error message, and returns to global configuration.
Examples
The following example configures the banner login to "Welcome to hostname:"
se-10-0-0-0# config tse-10-0-0-0 (config)# banner login %Enter TEXT message. End with the character '%'.Welcome to $(hostname)%se-10-0-0-0 (config)# exitThe following example configures the banner login to "Welcome to hostname.somewhere.com, enjoy:"
se-10-0-0-0# config tse-10-0-0-0 (config)# ip domain-name somewhere.comse-10-0-0-0 (config)# banner login @Enter TEXT message. End with the character '@'.Welcome to $(hostname).$(domain), enjoy!@se-10-0-0-0 (config)# exitThe following example configures the banner login to:
-----------------------------------You have entered a restricted area.Unauthorized access is prohibited.-----------------------------------se-10-0-0-0# config tse-10-0-0-0 (config)# banner login 1Enter TEXT message. End with the character '1'.-----------------------------------You have entered a restricted area.Unauthorized access is prohibited.-----------------------------------1se-10-0-0-0 (config)# exitRelated Commands