The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This command starts, stops, and provides the status of the system auditing service.
utils auditd { enable | disable | status }
Parameters | Description |
---|---|
enable |
Enables the collection of audit logs. When enabled, the system monitors and records user actions as well as Linux events such as the creation and removal of users, as well as the editing and deleting of files . |
disable |
Disables the collection of audit logs. |
status |
Displays the status of audit log collection. Cisco recommends that you retrieve the audit log by using the Real-Time Monitoring Tool, but you can also retrieve it by using the CLI. |
Administrator (admin:)
After the service has been enabled, it monitors and logs activity on the system. Be aware that the system auditing service logs a lot of information. Care must be taken not to overfill the disk.
Command privilege level: 1
Allowed during upgrade: Yes
utils core*
This command generates a backtrace for a core file, a thread list, and the current value of all CPU registers.
utils core { active | inactive } analyze [core_filename]
Parameters | Description |
---|---|
active |
Specifies an active version |
inactive |
Specifies an inactive version |
core_filename |
Specifies the name of the core file from which to generate the stack trace. |
Administrator (admin:)
This command creates a file of the same name as the core file, with a .txt extension, in the same directory as the core file. After you execute this command on a core file created by cimserver, an unexpected message displays. This message is a known limitation of the command.
Command privilege level: 1
Allowed during upgrade: Yes
This command displays all active or inactive core files.
utils core { active | inactive } list
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
This command creates reports about the server in the platform/log directory.
utils create report { csa | hardware | platform | security }
Parameters | Description |
---|---|
csa |
Collects all the files required for the Cisco Security Agent (CSA) diagnostics and assembles them into a single CSA diagnostics file. You can retrieve this file using the file get command. |
hardware |
Creates a system report that contains disk array, remote console, diagnostic, and environmental data. |
platform |
Collects the platform configuration files into a TAR file. |
security |
Collects the diagnostic reports and creates a TAR file that you can download for troubleshooting purposes. You can retrieve this file with the file get command. |
Administrator (admin:)
You are prompted to continue after you enter the command.
After you create a report, use the command file get activelog platform/log/filename command, to get the report. where filename specifies the report filename that displays after the command completes.
Command privilege level: 1
Allowed during upgrade: No
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). |
This command enables you to diagnose and attempt to automatically fix system problems.
utils diagnose { fix | list | module | test | version } [module_name]
Parameters | Description |
---|---|
fix |
Runs all diagnostic commands and attempts to fix problems. |
list |
Lists all available diagnostic commands. |
module |
Runs a single diagnostic command or group of commands and attempts to fix problems |
test |
Runs all diagnostic commands but does not attempt to fix problems. |
version |
Displays the diagnostic framework version. |
module_name |
Specifies the name of a diagnostics module. |
Administrator (admin:)
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.
agp
chpa
cucdmsync
dmasa
fulfillment
hlm
nbi
si
sdrcnf
ucpa
ucsmsync
vcentersync
This command invokes the backup and creates the tar file on the local drive.
utils disaster_recovery backup local featurelist device_name
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.
admin:utils disaster_recovery backup local HCS localdevice Backup initiated successfully. Please run 'utils showstatus backup' command to see the status.
This command starts a backup job and stores the resulting Tar file on a remote server.
utils disaster_recovery backup network featurelist path servername username
Note | The system prompts you to enter the password for the account on the remote server. |
This command cancels the ongoing backup job.
utils disaster_recovery cancel_backup confirm
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.
admin:utils disaster_recovery cancel_backup yes Cancelling backup... Backup cancelled successfully.
This command provides the estimated size of the last successful backup from the SFTP/local device.
utils disaster_recovery estimate_tar_size featurelist
featurelist specifies the list of features to back up, separated by commas.
Use utils disaster_recovery show_registration <servername> to display the list of registered features.
admin:utils disaster_recovery estimate_tar_size HCS Estimated tar size successfully: Estimated size of backup for selected features is 42.52 MB.
This command displays the history of previous backups and restores.
utils disaster_recovery history operation
operation specifies backup or restore
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
This command enables or disables the detailed maverick logging.
utils disaster_recovery maverick [enable] [disable]
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.
utils disaster_recovery device add
local device_name Number_of_backups
network device_name path server_name username Number_of_backups
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). |
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
This command deletes the specified device.
utils disaster_recovery device delete [device_name|*]
This command deletes all the existing devices except for the ones associated to a schedule.
This command displays the device name, device type, and device path for all the backup devices.
This command invokes the restore and takes the tar file from network drive.
utils disaster_recovery restore local restore_server tarfilename device_name
Note | The tar files must be stored in a restore directory before starting the restore operation. |
Use utils disaster_recovery device list to display the configured device list.
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.
This command starts a restore job and takes the backup Tar file from a remote server.
utils disaster_recovery restore network restore_server tarfilename path servername username
Note | The system prompts you to enter the password for the account on the remote server. |
This command affects schedules that are configured.
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
admin:utils disaster_recovery schedule list schedule name device name Schedule Status ---------------------------------------- schedule1 dev1 enabled schedule2 dev2 disabled
utils disaster_recovery schedule enable schedule1 Schedule enabled successfully.
utils disaster_recovery schedule disable schedule1 Schedule disabled successfully.
utils disaster_recovery show_backupfiles local backup|restore
directory—name of the local backup/restore directory
admin:utils disaster_recovery show_backupfiles local backup/restore 2009-05-14-21-12-00 2009-05-16-21-12-00
This command retrieves the information in the backup files that are available on tape.
utils disaster_recovery show_backupfiles tape tapeid
tapeid is mandatory and specifies the tape from which to display backup files.
To display the list of tape IDs, execute the utils disaster_recovery show_tapeid command.
admin:utils disaster_recovery show_backupfiles tape /dev/nst0 20050426181203853
This command retrieves information in the backup files that are available on the network drive.
utils disaster_recovery show_backupfiles network path servername userid
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
This command displays the registered features and components on the specified server.
utils disaster_recovery show_registration hostname
hostname specifies the server for which you want to display registration information.
This command displays the status of the current backup or restore job.
utils disaster_recovery status operation
operation specifies the name of the ongoing operation: backup or restore.
This commands enables and disables IPv4 firewall.
utils firewall ipv4 { enable | disable | [time] }
Parameters | Description |
---|---|
enable |
Turns on the IPv4 firewall. |
disable |
Turns off the IPv4 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes. |
time |
|
Administrator (admin:)
Command privilege level: 0
Allowed during upgrade: Yes
This commands enables and disables IPv6 firewall.
utils firewall ipv6 { enable | disable | [time] }
Parameters | Description |
---|---|
enable |
Turns on the IPv6 firewall. |
disable |
Turns off the IPv6 firewall. If you do not enter the time parameter, this command disables the firewall for 5 minutes. |
time |
|
Administrator (admin:)
You can use this command to enable or disable firewall tables. If you are testing the Unified Communications Manager for compliance with the USGv6 Profile, you must disable the IPv6 firewall tables for a duration of 23 hours before you begin the test.
Command privilege level: 0
Allowed during upgrade: Yes
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.
To execute this command on a VMware deployment that has been cloned (copied) from a template.
This command initiates an application level ping for the specified service running through the specified WS node. This will ensure the route is configured, ping the south bound application directly using a hardcoded message (for example, SOAP message), and ping the south bound application via the specified WS node (that is, proxy the message). The results of the various tests are displayed on the screen.
utils hcs api-gateway-proxy ping
None
Example: utils hcs api-gateway-proxy ping node danco danslab1 dancopub1
None
This command triggers the API Gateway Proxy service running on the specified WS node to resynchronize with the Shared Data Repository.
utils hcs api-gateway-proxy sync [all]
All: Syncs all.
utils hcs api-gateway-proxy sync all dlinton-hcmf-02
None
This command initiates fulfillment reprovisioning for each selected device. It performs all configuration for that device as though it had not been previously configured.
Note | Provisioning is normally an automatic process that does not require use of this command. While rarely necessary, the "utils reprovision" command can be useful after replacing a domain manager or if a device is found in an unexpected monitoring state. |
utils reprovision [cuom_monitored_devices | im_monitored_devices | individual_device]
cuom_monitored_devices: Triggers reprovisioning for all devices monitored by CUOM.
im_monitored_devices: Triggers reprovisioning for all devices monitored by IM.
individual_device: Triggers reprovisioning for a single device. The user is prompted as follows to identify the device:
Type of device? '(a)pplication' or '(c)ustomer-equipment':
Type of device identifier? '(h)ostname' or '(p)k':
Note: A "(p)k" is an internal identifier. Customers will typically select "h" for hostname. This option is for use when instructed by Cisco support.
Please enter hostname:
or
Please enter pk:
None
This command removes the HCS License Manager report file.
utils hcs hlm removeReportFile [File to Remove]
File to remove: The file to remove.
admin:utils hcs hlm removeReportFile large.file Successfully removed: large.file admin:utils hcs hlm removeReportFile large.file Unable to locate: large.file
None
This command displays the iostat output for the given number of iterations and intervals.
utils iostat { interval | iterations | filename }
Parameters | Description |
---|---|
interval |
Sets the seconds between two iostat readings. You must set this value if you are using the iteration parameter |
iterations |
Sets the number of iostat iterations. You must set this value if you are using the interval parameter. |
filename |
Redirects the output to a file. |
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: No
This command allows you to manage and monitor IO throttling on the server.
utils iothrottle { enable | disable | status }
Parameters | Description |
---|---|
Enable | Enables I/0 throttling enhancements which lowers the impact of upgrades on an active system. |
Disable | Disables I/0 throttling enhancements. |
Status | Displays the status of I/0 throttling enhancements. |
Administrator (admin:)
Disabling I/0 throttling enhancements can adversely affect the system during upgrades.
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.
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.
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.
utils migrate serviceinventory [hostname] [username]
Note | Make sure that the DNS is configured if the hostname is specified. |
This command lists the contents of the Address Resolution Protocol table.
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
In the Flags column, C=cached, M=permanent, P=published.
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
admin: utils network arp set myhost 11:22:33:44:55:66
admin: utils network arp delete myhost
This command captures IP packets on the specified Ethernet interface.
utils network capture eth0 [page] [numeric] [file fname] [count num] [size bytes] [src addr] [dest addr] [port num]
Note | If not specified and there is only one interface, by default it will be eth0. |
This command resolves a hostname to an address or an address to a hostname.
utils network host hostname [server server-name] [page] [detail] [srv]
hostname represents the hostname or IP address that you want to resolve.
This command displays information about a specified IPv6 address or hostname.
ping {IPv6-address | hostname} [count]
traceroute {IPv6-address | hostname}
host {IPv6-address | hostname}
This command allows you to ping another server.
utils network ping destination [count] [size]
destination represents the hostname or IP address of the server that you want to ping.
This command traces IP packets that are sent to a remote destination.
utils network traceroute destination
destination represents the hostname or IP address of the server to which you want to send a trace.
utils ntp*
utils ntp server add s1 [ s1 | s2 | s3 | s4 | s5 ] [norestart]
Parameters | Description |
---|---|
s1... |
Specifies the NTP servers. |
norestart |
Causes the NTP service to not restart after you add the servers. |
Administrator (admin:)
If you use norestart, an explicit restart of the NTP service is required for the changes to take effect.
Command privilege level: 0
Allowed during upgrade: Yes
admin: admin:utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8 Incorrect number of parameters entered for add usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]
admin: utils ntp server add s1 s2 s3 s4 s5 s6 s7 s8 Incorrect number of parameters entered for add usage: utils ntp server add s1 [s2 s3 s4 s5] [norestart]
admin: utils ntp server add clock1.cisco.com clock2.cisco.com clock1.cisco.com : added successfully. clock2.cisco.com : added successfully. Restarting NTP on the server.
admin: utils ntp server add clock1.cisco.com clock2.cisco.com clock1.cisco.com : [The host has already been added as an NTP server.] clock2.cisco.com : [The host has already been added as an NTP server.]
admin: utils ntp server add bglr-ccm26 bglr-ccm26 : [This server cannot be added as an NTP server.]
admin: utils ntp server add clock3.cisco.com clock3.cisco.com : [ Inaccessible NTP server. Not added. ]
admin: utils ntp server add ntp01-syd.cisco.com ntp02-syd.cisco.com clock.cisco.com norestart ntp01-syd.cisco.com : added successfully. ntp02-syd.cisco.com : added successfully. clock.cisco.com : added successfully. The NTP service will need to be restarted for the changes to take effect.
admin:utils ntp server add clock3.cisco.com The maximum permissible limit of 5 NTP servers is already configured.
This command deletes NTP servers that are configured.
utils ntp server delete
Administrator (admin:)
This command allows you to delete a configured NTP server or all of them. When you choose the server to delete, you are prompted to indicate if you want to restart the NTP service. If you choose no, the NTP service does not get restarted after the server is deleted.
Command privilege level: 0
Allowed during upgrade: Yes
admin: utils ntp server delete clock1.cisco.com clock2.cisco.com Incorrect number of optional parameters entered for delete usage: utils ntp server delete
admin: utils ntp server delete 1: clock1.cisco.com 2: clock2.cisco.com 3: ntp01-syd.cisco.com 4: ntp02-syd.cisco.com 5: clock.cisco.com a: all q: quit Choice: 1 Restart NTP (y/n): y clock1.cisco.com will be deleted from the list of configured NTP servers. Continue (y/n)?y clock1.cisco.com : deleted successfully. Restarting NTP on the server.
admin: utils ntp server delete 1: clock1.cisco.com 2: clock2.cisco.com 3: ntp01-syd.cisco.com 4: ntp02-syd.cisco.com 5: clock.cisco.com a: all q: quit Choice: a Restart NTP (y/n): n This will result in all the configured NTP servers being deleted. Continue (y/n)?y clock1.cisco.com : deleted successfully. clock2.cisco.com : deleted successfully. ntp01-syd.cisco.com : deleted successfully. ntp02-syd.cisco.com : deleted successfully. clock.cisco.com : deleted successfully. The NTP service will need to be restarted for the changes to take effect.
admin: utils ntp server delete There are no NTP servers configured to delete.
This command displays the current configuration of the NTP client and server.
Note | To avoid potential compatibility, accuracy, and network jitter problems, the external NTP servers that you specify for the primary node should be NTP v4 (version 4). If you are using IPv6 addressing, external NTP servers must be NTP v4. |
utils ntp config
Administrator (admin:)
Command privilege level: 0
Allowed during upgrade: Yes
This command restarts the NTP service.
utils ntp restart
Administrator (admin:)
Command privilege level: 0
Allowed during upgrade: Yes
This command lists all NTP servers.
utils ntp server list
Administrator (admin:)
Command privilege level: 0
Allowed during upgrade: Yes
This command starts the NTP service if it is not already running.
Note | You can not stop the NTP service from the command line interface. Use this command when the utils ntp status command returns stopped. |
utils ntp start
Administrator (admin:)
Command privilege level: 0
Allowed during upgrade: Yes
This command displays the current status of NTP.
utils ntp status
Administrator (admin:)
Command privilege level:
Allowed during upgrade:
utils os*
This command configures kerneldump to provide a kernel crash dumping mechanism. The kernel captures the dump to the local disk, in case of a kernel crash.
The MCS-7835-H2 and MCS-7845-H2 models do not support this command.
Note | The netdump commands have been removed from release 8.6(1) and have been replaced with the kerneldump commands. |
utils os kerneldump { enable | disable }
Administrator (admin:)
If a kernel crash occurs, the capture kernel dumps the core on the local disk of the server. The primary kernel reserves 128MB of physical memory that the capture kernel uses to boot. The kerneldump uses the kexec command to boot into a capture kernel whenever the kernel crashes.
Command privilege level: 1
Allowed during upgrade: Yes
admin: utils os kerneldump enable ***************WARNING******************* Enabling kerneldump requires system reboot Would you like to boot the machine (y/n):y kerneldump enable operation succeeded System going for a reboot
This command enables, disables, or displays the status of an external SSH server.
utils os kerneldump ssh { enable | disable | status }
Parameters | Description |
---|---|
enable |
Configures an external SSH server as a kerneldump server to kernel dumps. |
disable |
Removes support of the external SSH server that is configured to collect kernel dumps. |
status |
Indicates whether an external SSH server is configured or not, to collect kernel dumps. |
Administrator (admin:)
If external SSH server has the kerneldump service enabled and a kernel crash occurs, the capture kernel dumps the core on the external server that is configured to collect the dump.
Enabling and disabling kerneldump require a system reboot for the changes to come into effect.
Command privilege level: 1
Allowed during upgrade: Yes
admin: utils os kerneldump ssh disable 10.77.31.60 Disabling kerneldump requires system reboot Would you like to continue (y/n): y kerneldump disable operation succeeded System going for a reboot
This command is used to specify the level of security provided by selinux.
utils os secure { enforce | permissive | status }
Parameters | Description |
---|---|
enforce | |
permissive | |
status |
Administrator (admin:)
Note that selinux does not handle rate limiting. Rate limiting is handled by ipprefs and ip tables.
Command privilege level: 1
Allowed during upgrade: No
utils remote_account*
This command creates a remote account.
utils remote_account create
Administrator (admin:)
A remote account generates a pass phrase that allows Cisco Systems support personnel to get access to the system for the specified life of the account.
Command privilege level: 1
Allowed during upgrade: Yes
This command allows you to disable a remote account.
utils remote_account disable
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
This command allows you to enable a remote account.
utils remote_account enable
Administrator (admin:)
You can have only one remote account that is enabled at a time.
Command privilege level: 1
Allowed during upgrade: Yes
This command allows you to check the status of a remote account.
utils remote_account status
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
This command activates, deactivates, stops, starts, or restarts a service.
activate service-name
deactivate service-name
start service-name
stop service-name
restart service-name
This command retrieves a list of all services and their status.
utils snmp*
This interactive command adds, deletes, lists or updates a community string.
utils snmp config 1/2c community-string { add | | delete | | list | | update }
Parameters | Description |
---|---|
add |
Adds a new community string. |
delete |
Deletes a community string. |
list |
Lists all community strings. |
update |
Updates a community string. |
Administrator (admin:)
The system prompts you for the parameters.
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of “SNMP Master Agent” by using utils service list. If service is down, start it by using utils service start SNMP Master Agent
This interactive command adds, deletes, lists or updates inform notification destinations.
utils snmp config 1/2c inform { add | | delete | | list | | update }
Parameters | Description |
---|---|
add |
Adds a notification destination. |
delete |
Deletes a notification destination. |
list |
Lists all notification destinations. |
update |
Updates a notification destination. |
Administrator (admin:)
This interactive command affects trap notifications.
utils snmp config 1/2c trap { add | delete | list | update }
Parameters | Description |
---|---|
add |
Adds a new v1/2c trap notification destination associated with a configured v1/2c community string. |
delete |
Deletes the configuration information for an existing v1/2c trap notification destination. |
list |
Lists the v1/2c trap notifications currently configured. |
update |
Updates configuration information for an existing v1/2c trap notification destination. |
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the v3 inform notification.
utils snmp config 3 inform { add | | delete | | list | | update }
Parameters | Description |
---|---|
add |
Adds a new v3 inform notification destination associated with a configured v3 username. |
delete |
Deletes the configuration information for an existing v3 inform notification destination. |
list |
Lists the v3 inform notifications currently configured. |
update |
Updates configuration information for an existing v3 inform notification destination. |
Administrator (admin:)
The system prompts you for the parameters.
The SNMP Master Agent service is restarted for configuration changes to take effect. Do not abort command after execution until restart is complete. If the command is aborted during service restart, verify service status of “SNMP Master Agent” by using utils service list. If service is down, start it by using utils service start SNMP Master Agent
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects the Mib2 configuration information.
utils snmp config mib2 { add | | delete | | list | | update }
Parameters | Description |
---|---|
add |
Adds the Mib2 configuration information. |
delete |
Deletes the Mib2 configuration information. |
list |
Lists the Mib2 configuration information. |
update |
Updates the Mib2 configuration information. |
Administrator (admin:)
The system prompts you for the parameters.
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects trap notifications.
utils snmp config 3 trap { add | | delete | | list | | update }
Parameters | Description |
---|---|
add |
Adds a new v3 trap notification destination associated with a configured v3 username. |
delete |
Deletes the configuration information for an existing v 3 trap notification destination. |
list |
Lists the v3 trap notifications currently configured. |
update |
Updates configuration information for an existing v3 trap notification destination. |
Administrator (admin:)
The system prompts you for the parameters.
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command affects v3 user configuration.
utils snmp config 3 user { add | | delete | | list | | update }
Parameters | Description |
---|---|
add |
Adds a new v3 user with the v3 authentication and privacy passwords. |
delete |
Deletes the configuration information for an existing v3 user. |
list |
Lists the v3 users currently configured. |
update |
Updates configuration information for an existing v3 user. |
Administrator (admin:)
The system prompts you for the parameters.
Command privilege level: 1
Allowed during upgrade: Yes
This interactive command gets the SNMP data using the specified version for the specified MIB OID.
utils snmp get version
Parameters | Description |
---|---|
version |
Specifies the SNMP version. Possible values include 1, 2c or 3. |
community |
Specifies the SNMP community string. |
ip-address |
Specifies the IP address of the server. Enter 127.0.0.0 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node. |
object |
Specifies the SNMP Object ID (OID) to get. |
file |
Specifies a file in which to save the command output. |
Administrator (admin:)
If you run the command on a specific OID (leaf) in the MIB you would get the value of the MIB. For example to get the system uptime: iso.3.6.1.2.1.25.1.1.0 = Timeticks: (19836825) 2 days, 7:06:08.25
If you provide the IP address of a remote host, the command gets executed on the remote host.
Be aware that the IP address is required. You cannot use a domain name.
Command privilege level: 1
Allowed during upgrade: Yes
This command affects the SNMP agents on the server.
utils snmp hardware-agents { status | | start | | stop | | restart }
Parameters | Description | ||
---|---|---|---|
status |
Displays the status of the SNMP agents provided by the vendor of the hardware.
|
||
stop |
Stops all SNMP agents provided by the hardware vendor. |
||
restart |
Restarts all of the SNMP agents provided by the vendor of the hardware. |
||
start |
Starts all of the SNMP agents provided by the vendor of the hardware. |
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
This command sends sample alarms to local syslog and remote syslog.
utils snmp test
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
admin: admin:utils snmp test
Service Manager is running
Test SNMP Trap starts with Local Host Name, Specify a Remote Sever Name to test Remote Syslog
TestAlarmInformational sent [Returncode=0]
TestAlarmEmergency sent [Returncode=0]
TestAlarmAlert sent [returncode=0]
TestAlarmCritical sent [Returncode=0]
TestAlarmDebug sent [Returncode=0]
TestAlarmNotice sent [Returncode=0]
TestAlarmWarning sent [Returncode=0]
TestAlarmError sent [Returncode=0]
TestAlarmWindows sent [Returncode=0]
Message from syslogd@ipcbu-plat44 at Sat Jul 17 03:56:11 2010 ...
ipcbu-plat44 local7 0 : 1: ipcbu-plat44.blr.eng: Jul 16 2010 22:26:11.53 UTC :
%UC_-0-TestAlarmEmergency: %[AppID=Cisco CallManager][ClusterID=][NodeID=ipcbu-plat44]:
Testing EMERGENCY_ALARM
This interactive commands walks through the SNMP MIB using the specified version, starting with the specified OID.
utils snmp walk version
Parameters | Description |
---|---|
version |
Specifies the SNMP version. Possible values include 1, 2c or 3. |
community |
Specifies the SNMP community string. |
ip-address |
Specifies the IP address of the server. Enter 127.0.0.0 to specify the local host. You can enter the IP address of another node in the cluster to run the command on that node. |
object |
Specifies the SNMP Object ID (OID) to walk |
file |
Specifies a file in which to save the command output. |
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
iso.3.6.1.2.1.1.1.0 = STRING: "Hardware:7825H, 1 Intel(R) Pentium(R) 4 CPU 3.40GHz, 2048 MB Memory: Software:UCOS 2.0.1.0-62"
iso.3.6.1.2.1.1.2.0 = OID: iso.3.6.1.4.1.9.1.583
iso.3.6.1.2.1.1.3.0 = Timeticks: (15878339) 1 day, 20:06:23.39
iso.3.6.1.2.1.1.4.0 = ""
iso.3.6.1.2.1.1.5.0 = STRING: "bldr-ccm34.cisco.com"
iso.3.6.1.2.1.1.6.0 = ""
iso.3.6.1.2.1.1.7.0 = INTEGER: 72
iso.3.6.1.2.1.2.1.0 = INTEGER: 3
iso.3.6.1.2.1.2.2.1.1.1 = INTEGER: 1
iso.3.6.1.2.1.2.2.1.1.2 = INTEGER: 2
iso.3.6.1.2.1.2.2.1.1.3 = INTEGER: 3
iso.3.6.1.2.1.2.2.1.2.1 = STRING: "lo"
Press <enter> for 1 line, <space> for one page, or <q> to quit
utils system*
This command allows you to restart the system on the same partition.
utils system restart
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: No
This command allows you to shut down the system.
utils system shutdown
Administrator (admin:)
This command has a five-minute timeout. If the system does not shut down within five minutes, the command gives you the option of doing a forced shutdown.
Command privilege level: 1
Allowed during upgrade: No
This command allows you to restart the system on the inactive partition.
utils system switch-version
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: No
This command redirects where the system boot output gets sent.
utils system boot { console | serial }
Parameters | Description |
---|---|
console |
Redirects the system boot output to the console. |
serial |
Redirects the system boot output to the COM1 (serial port 1). |
Administrator (admin:)
Command privilege level: 1
Allowed during upgrade: Yes
This command allows you to install upgrades and Cisco Option (COP) files from both local and remote directories.
utils system upgrade { initiate | cancel | status }
Parameters | Description |
---|---|
cancel |
Cancels the active upgrade. |
initiate |
Starts a new upgrade wizard or assumes control of an existing upgrade wizard. The wizard prompts you for the location of the upgrade file. |
status |
Displays the status of an upgrade. |
Administrator (admin:)
utils vmtools*
This command displays the status of VMware Tools.
utils vmtools refresh
Administrator (admin:)
admin:utils vmtools refresh VMWare tools are OK. No further action is needed
This command updates the currently installed VMware Tools to the latest version prescribed by the ESXi host for that VM.
utils vmtools upgrade
Administrator (admin:)