Syntax Description

Syntax Description

Syntax Description

This command is not supported for HCM-F. Refer to utils os secure permissive CLI command for replacement.

Note	The command, set csa disable, is not applicable to HCM-F. Although the CLI menu option exists, CSA is no longer supported. If you try to disable CSA, you will receive the output response admin:utils csa disable (which is no longer supported).

This command is not supported for HCM-F. Refer to utils os secure enforce CLI command for replacement.

Note	The command, set csa enable, is not applicable to HCM-F. Although the CLI menu option exists, CSA is no longer supported. If you try to enable CSA, you will receive the output response admin:utils csa enable. The output is no longer supported.

This command is not supported for HCM-F. Refer to utils os secure status CLI command for replacement.

Note	The command, set csa status, is not applicable to HCM-F. Although the CLI menu option exists, CSA is no longer supported. If you try to set the status for CSA, you will receive the output response admin:utils csa status (which is no longer supported).

Syntax Description

This command enables you to diagnose problems for HCS services. The information is helpful for debugging purposes.

This command can be executed from any node in the cluster.

Command Syntax

utils diagnose hcs

agp

chpa

cucdmsync

dmasa

fulfillment

hlm

nbi

si

sdrcnf

ucpa

ucsmsync

vcentersync

Parameters

• agp displays the diagnostics information for the API Gateway Proxy service.
• chpa displays the diagnostics information for the Provisioning Adapter Service.
• cucdmsync displays the diagnostics information for the CUCDMSync Service.
• dmaim displays the diagnostics information for the DMA-IM.
• fulfillment displays the diagnostics information for the fulfillment Service.
• hlm displays the diagnostics information for the HCS License Manager Service.
• nbi displays the diagnostics information for the North Bound Interface Service.
• si displays the diagnostics information for the Service Inventory Service.
• sdrcnf displays the diagnostics information for the SDR Change Notification Service.
• ucpa displays the diagnostic information for the Unity Connection Provisioning Adapter. It used by Service Inventory.
• ucsmsync displays the diagnostics information for the UCSMSync Service.
• vcentersync displays the diagnostics information for the VCenterSync Service.

Requirements

Command privilege level: 0

Allowed during upgrade: No

This command invokes the backup and creates the tar file on the local drive.

Command Syntax

utils disaster_recovery backup local featurelist device_name

Parameters

• featurelist is mandatory and comprises a comma-separated feature list to back up.
• device_name is mandatory and specifies the name of the backup device to be added.

Usage Guidelines

Use utils disaster_recovery show_registration to display the list of registered features.

Use utils disaster_recovery device list to display the configured device list.

Example

admin:utils disaster_recovery backup local HCS localdevice 
Backup initiated successfully. Please run 'utils showstatus backup' 
command to see the status.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command starts a backup job and stores the resulting Tar file on a remote server.

Command Syntax

utils disaster_recovery backup network featurelist path servername username

Parameters

• featurelist specifies the list of features to back up, separated by commas.
• path represents the location of the backup files on the remote server.
• servername represents the IP address or hostname of the server where you stored the backup files.
• username represents the username that is needed to log in to the remote server.

Usage Guidelines

Note	The system prompts you to enter the password for the account on the remote server.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command cancels the ongoing backup job.

Command Syntax

utils disaster_recovery cancel_backup confirm

Usage Guidelines

After you enter the command, you must confirm that you want to cancel the backup. Enter Y to cancel the backup or any other key to continue the backup.

Example

admin:utils disaster_recovery cancel_backup yes
Cancelling backup...
Backup cancelled successfully.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command provides the estimated size of the last successful backup from the SFTP/local device.

Command Syntax

utils disaster_recovery estimate_tar_size featurelist

Parameters

featurelist specifies the list of features to back up, separated by commas.

Usage Guidelines

Use utils disaster_recovery show_registration <servername> to display the list of registered features.

Example

admin:utils disaster_recovery estimate_tar_size HCS
Estimated tar size successfully: Estimated size of backup for selected features is 
42.52 MB.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command displays the history of previous backups and restores.

Command Syntax

utils disaster_recovery history operation

Parameters

operation specifies backup or restore

Example

admin:utils disaster_recovery history backup
Tar Filename: Backup Device: Completed On: Result: Backup Type: Features Backed Up:
2009-10-30-14-53-32.tar TAPE Fri Oct 30 14:55:31 CDT 2009 ERROR MANUAL
2009-12-10-10-30-17.tar TAPE Thu Dec 10 10:35:22 CST 2009 SUCCESS MANUAL
CDR_CAR,CCM

Requirements

Command privilege level: 1

Allowed during upgrade: No

This command enables or disables the detailed maverick logging.

Command Syntax

utils disaster_recovery maverick [enable] [disable]

Parameters

• enable enables the detailed maverick logging
• disable disables the detailed maverick logging

Example

admin:utils disaster_recovery maverick enable 
drfCliCommand: maverick Maverick detailed logging enabled. 
Restart Master and Local Agent in this machine for the changes to take effect. 

admin:utils disaster_recovery maverick disable 
drfCliCommand: maverick Maverick detailed logging disabled.
Restart Master and Local Agent in this machine for the changes to take effect. 

Requirements

Command privilege level: 1

Allowed during upgrade: No

This command adds:

• backup tape device
• backup local device
• backup network device

Command Syntax

utils disaster_recovery device add

local device_name Number_of_backups

network device_name path server_name username Number_of_backups

Parameters

• device_name—name of the backup device to be added
• path—path to retrieve backup device from this location
• server_name—hostname of the server where the backup file needs to be stored
• username—user ID to connect to the remote machine
• Number_of_backups—Number of backups to be stored on the local or the network directory (default value is 2)

Note	If there is more than one node in the cluster, each node in the cluster must be backed up to a unique directory (see example below).

Example:

admin:utils disaster_recovery device add network networkDevice /backup/app1 
10.77.31.116 root 3
utils disaster_recovery device add network networkDevice /backup/ws1
10.77.31.116 root 3
utils disaster_recovery device add network networkDevice /backup/ws2
10.77.31.116 root 3 

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command deletes the specified device.

Command Syntax

utils disaster_recovery device delete [device_name|*]

Parameters

• device_name is mandatory and specifies the name of the device to be deleted.
• * deletes all the existing devices except for the ones associated to a schedule

Usage Guidelines

This command deletes all the existing devices except for the ones associated to a schedule.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command displays the device name, device type, and device path for all the backup devices.

Command Syntax

utils disaster_recovery device list

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command invokes the restore and takes the tar file from network drive.

Command Syntax

utils disaster_recovery restore local restore_server tarfilename device_name

Parameters

• restore_server is mandatory and represents the hostname of the server to be restored.
• tarfilename is mandatory and specifies the file that will get restored (without the file extension, for example: 2008-01-21-18-25-03).
• device_name is mandatory and specifies the name of the backup device to be added.

Note	The tar files must be stored in a restore directory before starting the restore operation.

Usage Guidelines

Use utils disaster_recovery device list to display the configured device list.

Example

admin:utils disaster_recovery restore local SW075B-CM11 2008-01-21-18-25-03 localdevice
Restore initiated successfully. Please run 'utils showstatus restore' command to see 
the status.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command starts a restore job and takes the backup Tar file from a remote server.

Command Syntax

utils disaster_recovery restore network restore_server tarfilename path servername username

Parameters

• restore_server specifies the hostname of the server that you want to restore.
• tarfilename specifies the name of the file to restore.
• path represents the location of the backup files on the remote server.
• servername represents the IP address or hostname of the server where you stored the backup files.
• username represents the username that you need to log in to the remote server.

Usage Guidelines

Note	The system prompts you to enter the password for the account on the remote server.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command affects schedules that are configured.

Command Syntax

utils disaster_recovery schedule

list

Command privilege level: 1

Allowed during upgrade: Yes

add schedulename devicename featurelist datetime frequency

Command privilege level: 1

Allowed during upgrade: No

enable schedulename

Command privilege level: 1

Allowed during upgrade: Yes

disable schedulename

Command privilege level: 1

Allowed during upgrade: No

delete [schedulename|*]

Command privilege level: 1

Allowed during upgrade: No

Parameters

• list displays the schedules that are configured.
• add adds the configured schedules.
• enable enables the specified schedule.
• disable disables the specified schedule
• delete deletes the specified schedule.

Options

• schedulename (mandatory) name of the scheduler
• devicename (mandatory) name of the device for which scheduling is done
• featurelist (mandatory) comma-separated feature list to back up
• datetime (mandatory) date when the scheduler is set. Format specified: (yyyy/mm/dd-hh:mm) 24-hrs clock
• frequency (mandatory) frequency at which the scheduler is set to take a backup. Examples: once, daily, weekly and monthly
• * all

List Example

admin:utils disaster_recovery schedule list
schedule name device name Schedule Status
----------------------------------------
schedule1      dev1         enabled
schedule2      dev2         disabled

Enable Example

utils disaster_recovery schedule enable schedule1
Schedule enabled successfully.

Disable Example

utils disaster_recovery schedule disable schedule1
Schedule disabled successfully.

Command Syntax

utils disaster_recovery show_backupfiles local backup|restore

Parameters

directory—name of the local backup/restore directory

Example

admin:utils disaster_recovery show_backupfiles local backup/restore
2009-05-14-21-12-00
2009-05-16-21-12-00

Requirements

Command privilege level: 1

Allowed during upgrade: No

This command retrieves the information in the backup files that are available on tape.

Command Syntax

utils disaster_recovery show_backupfiles tape tapeid

Parameters

tapeid is mandatory and specifies the tape from which to display backup files.

Usage Guidelines

To display the list of tape IDs, execute the utils disaster_recovery show_tapeid command.

Example

admin:utils disaster_recovery show_backupfiles tape /dev/nst0
20050426181203853

Requirements

Command privilege level: 1

Allowed during upgrade: No

This command retrieves information in the backup files that are available on the network drive.

Command Syntax

utils disaster_recovery show_backupfiles network path servername userid

Parameters

• path is mandatory and specifies the path to the backup files location.
• servername is mandatory and specifies the server IP address/hostname where the backup file is stored.
• userid is mandatory and specifies the user ID used to connect to the remote machine.

Example

admin:utils disaster_recovery show_backupfiles network /usr/local/ 10.77.31.55
administrator
Please enter password to connect to network server 10.77.31.55:****
20050426181203855
20050426181203853
20050426181203857

Requirements

Command privilege level: 1

Allowed during upgrade: No

This command displays the registered features and components on the specified server.

Command Syntax

utils disaster_recovery show_registration hostname

Parameters

hostname specifies the server for which you want to display registration information.

Requirements

Command privilege level: 1

Allowed during upgrade: No

This command displays the status of the current backup or restore job.

Command Syntax

utils disaster_recovery status operation

Parameters

operation specifies the name of the ongoing operation: backup or restore.

Requirements

Command privilege level: 1

Allowed during upgrade: No

Syntax Description

Syntax Description

This command takes data from the platformConfig.xml file on the virtual floppy drive and modifies the system to match the configuration file. The system reboots after the command successfully completes.

Command Syntax

utils import config

Parameters

None

Usage guidelines

To execute this command on a VMware deployment that has been cloned (copied) from a template.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Syntax Description

Syntax Description

This command configures your system to use an FQDN for LDAP authentication. If your system is not DNS configured, use the command: utils ldap config ipaddr.

Command Syntax

utils ldap config fqdn

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command configures your system to use an IP address for LDAP authentication. This is not the preferred method. It is required if your system is not or cannot be configured to use DNS. In such case use the command: utils ldap config fqdn.

Command Syntax

utils ldap config ipaddr

Parameters

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command migrates configuration data and backs up report files from another host that is running HCS Service Inventory to the local host that is running HCS Service Inventory.

For HCM-F Release 8.6(2)ES1 platform, this command upgrades HCS Service Inventory 8.6(1)ES1 to HCS Service Inventory 8.6(2)ES1. For more information, refer to the Upgrading Components for Cisco Hosted Collaboration Solution for (HCS) 8.6(2)ES1.

Command Syntax

utils migrate serviceinventory [hostname] [username]

Parameters

• hostname represents the hostname or IP address of the server that is running the older software version of Service Inventory.

Note	Make sure that the DNS is configured if the hostname is specified.

• username represents a valid user account name on the server that is running the older software version of Service Inventory.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

This command lists the contents of the Address Resolution Protocol table.

Command Syntax

utils network arp

list [host hostname] [options]

Command privilege level: 0

Allowed during upgrade: No

set host addr

Command privilege level: 1

Allowed during upgrade: No

delete host

Command privilege level: 1

Allowed during upgrade: Yes

Options

• host (optional) specifies host you want to list/set/delete.
• hostname (optional) the hostname of the specified host.
• options (optional) page, numeric
  • page pauses output.
  • numeric shows hosts as dotted IP addresses.
• addr (mandatory) the hardware address (MAC) of the host.
  • Format XX:XX:XX:XX:XX:XX
  • Format XX:XX:XX:XX:XX:XX

List Usage Guidelines

In the Flags column, C=cached, M=permanent, P=published.

List Example

admin: utils network arp list
Address                  HWtype  HWaddress           Flags Mask           Iface
sjc21-3f-hsrp.cisco.com  ether   00:00:0C:07:AC:71   C                    eth0
philly.cisco.com         ether   00:D0:B7:85:98:8E   C                    eth0
Entries: 2      Skipped: 0      Found: 2

Set Example

admin: utils network arp set myhost 11:22:33:44:55:66

Delete Example

admin: utils network arp delete myhost

This command captures IP packets on the specified Ethernet interface.

Command Syntax

utils network capture eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]

Parameters

eth0 (Optional) Specifies Ethernet interface 0.

Note	If not specified and there is only one interface, by default it will be eth0.

Options

• page—Displays the output one page at a time When you use the page or file options, the complete capture of all requested packets must occur before the command completes.
• numeric—Displays hosts as dotted IP addresses
• file fname—Outputs the information to a file The file option saves the information to platform/cli/fname.cap. The filename cannot contain the '.' character.
• count num—Sets a count of the number of packets to capture For screen output, the maximum count equals 1000, and, for file output, the maximum count equals 10000.
• size bytes—Sets the number of bytes of the packet to capture For screen output, the maximum number of bytes equals 128, for file output, the maximum of bytes can be any number or ALL.
• src addr—Specifies the source address of the packet as a hostname or IPv4 address
• dest addr—Specifies the destination address of the packet as a hostname or IPv4 address
• port num—Specifies the port number of the packet, either source or destination

Requirements

Command privilege level: 0

Allowed during upgrade: No