Cisco TelePresence Recording Server Release 1.6 Command Reference - CTRS Set Commands [Cisco TelePresence Recording Server]

Table Of Contents

CTRS Set Commands

set account

set commandcount

set diskalertthreshold

set hdcapable

set ldcapable

set logging

set network dhcp eth0

set network dns

set network dns options

set network domain

set network failover

set network gateway

set network hostname

set network ip eth0

set network max_ip_conntrack

set network mtu

set network nic eth0 auto

set network nic eth0 speed

set network nic eth0 duplex

set network pmtud

set network status eth0

set password admin

set snmp trapdest add

set snmp trapdest del

set snmp user add

set snmp user del

set syslog facility

set syslog heartbeat facility

set syslog heartbeat interval

set syslog heartbeat msg

set syslog heartbeat severity

set syslog timezone

set syslog version

set timezone

set videoquality

set web-security

set workingdir activelog

set workingdir inactivelog

CTRS Set Commands

Revised: November 2009, OL-19547-01

This chapter contains Cisco TelePresence Recording Server (CTRS) set commands:

•set account

•set commandcount

•set diskalertthreshold

•set hdcapable

•set ldcapable

•set logging

•set network dhcp eth0

•set network dns

•set network dns options

•set network domain

•set network failover

•set network gateway

•set network hostname

•set network ip eth0

•set network max_ip_conntrack

•set network mtu

•set network nic eth0 auto

•set network nic eth0 speed

•set network nic eth0 duplex

•set network pmtud

•set network status eth0

•set password admin

•set snmp trapdest add

•set snmp trapdest del

•set snmp user add

•set snmp user del

•set syslog facility

•set syslog heartbeat facility

•set syslog heartbeat interval

•set syslog heartbeat msg

•set syslog heartbeat severity

•set syslog timezone

•set syslog version

•set timezone

•set videoquality

•set web-security

•set workingdir activelog

•set workingdir inactivelog

Note For information about using the CTRS administration software, refer to the Cisco TelePresence Recording Server Release 1.6 Administration Guide at the following URL:

http://www.cisco.com/en/US/products/ps10341/prod_maintenance_guides_list.html

set account

set account name
Syntax Description

name

Name of the administrative account.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to create a new administrative account. You will be prompted for the appropriate privilege level and password during account creation.

Examples
admin:set account test2
Please enter the privilege level :1
       Please enter the password :******
             re-enter to confirm :******
set commandcount

set commandcount {enable | disable}
Syntax Description

enable

Enables command count feature. Using enable changes the CLI command prompt so that it displays a numeric value showing how many CLI commands have been executed

disable

Disables command count feature. Using disable changes the CLI command prompt so that it stops displaying a numeric value showing how many CLI commands have been executed.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to either enable or disable the command count feature. This command changes the CLI command prompt so that it displays a numeric value showing how many CLI commands have been executed. This setting is valid for current session only.

Examples
admin:set commandcount enable
admin 0005:
set diskalertthreshold

set diskalertthreshold threshold percentage
Syntax Description

threshold percentage

Threshold percentage for disk usage. Valid values are from 1 to 100. The default is 80.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to specify a threshold percentage for disk usage. If this threshold percentage is reached, the CTRS sends the administrator an alert by email.

Examples
admin:set diskalertthreshold threshold 85
set hdcapable

set hdcapable {enable | disable}
Syntax Description

enable

Enables HD recording capability.

disable

Disables HD recording capability.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to either enable or disable HD recording capability.

Examples
admin:set hdcapable disable
set ldcapable

set ldcapable {enable | disable}
Syntax Description

enable

Enables LD (CIF) recording capability.

disable

Disables LD (CIF) recording capability.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to either enable or disable LD (CIF) recording capability.

Examples
admin:set ldcapable disable
set logging

set logging {enable | disable}
Syntax Description

enable

Enables logging.

disable

Disables logging.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to either enable or disable logging for the current admin accounts.

Examples
admin:set logging enable
set network dhcp eth0

set network dhcp eth0 {enable | disable node_ip net_mask gateway_ip}
Syntax Description

enable

Sets the Ethernet interface to use Dynamic Host Configuration Protocol (DHCP).

disable

Sets the Ethernet interface NOT to use DHCP.

node_ip

Node IP address

net_mask

Subnet mask

gateway_ip

Gateway IP address

Command Modes

Admin

Command History

Release

Modification

1.6

This command was first documented.

Usage Guidelines

Use this command (with the enable keyword) to set the Ethernet interface to use Dynamic Host Configuration Protocol (DHCP) if not already enabled, then to restart the system.

Use this command (with the disable keyword) to set the Ethernet interface to not use DHCP provided DHCP is enabled, then to restart the system.

Examples
admin:set network dhcp eth0 enable
          ***   W A R N I N G   ***
This will cause the system to restart - Do you want to continue ?
Enter "yes" to continue and restart or any other key to abort
yes
executing...
Broadcast message from root (Thu Jun 24 13:00:21 2004):
The system is going down for restart NOW!
admin:set network dhcp eth0 disable 1.2.3.4  255.255.255.0  5.4.3.2
          ***   W A R N I N G   ***
This will cause the system to restart - Do you want to continue ?
Enter "yes" to continue and restart or any other key to abort
yes
executing...
Broadcast message from root (Thu Jun 24 13:00:21 2004):
The system is going down for restart NOW!
set network dns

set network dns {primary address | secondary address}
Syntax Description

primary address

Defines a new address for the primary Domain Name System (DNS) server. Values for address are valid dotted decimal IP addresses.

secondary address

Defines a new address for the secondary DNS server. Values for address are valid dotted decimal IP addresses.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to define new IP addresses for primary or secondary DNS servers.

This command causes a temporary loss of network connectivity. If you want to continue with defining a new address for the DNS server, type Yes. Otherwise, click any other key to abort.

Examples
admin:set network dns primary 1.2.3.4
*** WARNING ***
This will cause the system to temporarily lose network connectivity
Do you want to continue?
Enter "yes" to continue or any other key to abort
yes
set network dns options

set network dns options [timeout value] [attempts value] [rotate]
Syntax Description

timeout value

Defines how long CTRS waits before considering a Domain Name System (DNS) query to have failed. Value indicates number of seconds.

attempts value

Defines the number of times CTRS repeats a DNS query before considering the query to have failed. Value indicates number of attempts.

rotate

Defines the way in which DNS servers are contacted (round-robin fashion). This options distributes the load across DNS servers.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set optional features in contacting DNS servers, such as the way in which DNS servers are contacted, the amount of time and the number of retries before a DNS query is considered a failed attempt.

This command causes a temporary loss of network connectivity.

Examples
admin:set network dns options timeout 10
          ***   W A R N I N G   ***
This will cause the system to temporarily lose network connectivity
          Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...
set network domain

set network domain name
Syntax Description

name

Defines domain name in which the CTRS resides.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the domain of the CTRS.

This command causes a temporary loss of network connectivity.

Examples
admin:set network domain cisco.com
          ***   W A R N I N G   ***
This will cause the system to temporarily lose network connectivity
          Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...
set network failover

set network failover {enable | disable}
Syntax Description

enable

Enables network failover

disable

Disables network failover

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to enable or disable network failover.

Enabling network failover creates a virtual interface (bond0) that uses Ethernet interface eth0, but fails over to Ethernet interface eth1 if eth0 fails. All three interfaces (bond0, eth0, and eth1) share the same IP and MAC address.

Disabling network failover restores Ethernet interface eth0 with equivalent configuration parameters and removes the virtual interface bond0.

Setting failover will cause a restart of the system.

Examples
admin:set network failover enable
Creating virtual interface bond0 to failover ethernet interface eth0 to eth1
should eth0 fail.
          ***   W A R N I N G   ***
This will cause the system to restart - Do you want to continue?
Enter "yes" to continue and restart or any other key to abort
yes
executing...
set network gateway

set network gateway address
Syntax Description

address

Defines new gateway IP address.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set a new gateway IP address; this command causes a temporary loss of network connectivity.

Note Entering the wrong gateway address effectively disables network access to this node.

Examples
admin:set network gateway 192.168.1.1
          ***   W A R N I N G   ***
This will cause the system to temporarily lose network connectivity
          Do you want to continue ?
Enter "yes" to continue or any other key to abort
set network hostname

set network hostname name
Syntax Description

name

Defines hostname.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the network hostname; this command causes a restart of the system.

Note The hostname must start with a letter, end with an alphanumeric, and may contain any alphanumeric characters or hyphen in between. The hostname must be 63 characters or less.

Examples
admin:set network hostname myname
          ***   W A R N I N G   ***
This will cause the system to restart - Do you want to continue ?
Enter "yes" to continue and restart or any other key to abort
yes
executing...
Broadcast message from root (Thu Jun 24 13:00:21 2004):
The system is going down for restart NOW!
set network ip eth0

set network ip eth0 address
Syntax Description

address

Defines a new IP address and subnet mask for Ethernet 0. Values for address are valid dotted decimal IP addresses followed by subnet mask value.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to define a new IP address and subnet mask for Ethernet 0. The system automatically restarts after you execute this command.

Examples
admin:set network ip eth0 192.168.1.5 255.255.255.0
*** WARNING ***
This will cause the system to restart - Do you want to continue?
Enter "yes" to continue and restart or any other key to abort
yes
set network max_ip_conntrack

set network max_ip_contrack value
Syntax Description

value

Defines ip_conntrack_max value.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the ip_conntrack_max value.

Examples
admin:set network max_ip_conntrack 256000
set network mtu

set network mtu value
Syntax Description

value

Defines MTU maximum size. Standard size is 1500.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the MTU maximum size. This command causes a temporary loss of network connectivity.

Examples
admin:set network mtu 576
          ***   W A R N I N G   ***
This will cause the system to temporarily lose network connectivity
          Do you want to continue ?
Enter "yes" to continue or any other key to abort
yes
executing...
set network nic eth0 auto

set network nic eth0 auto {en | dis}
Syntax Description

en

Enables auto negotiation

dis

Disabled auto negotiation

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to configure auto negotiation for speed and duplex settings for a Network Interface card (NIC), meaning that CRMS will attempt to negotiate the highest speed possible with the switch. Per the IEEE standard, 1000BASE-T (1 GB Ethernet) can only be enabled via auto-negotiation.

Note For the changes to take effect, the NIC will be reset, which will cause a temporary loss of network connectivity.

Examples
admin:set network nic eth0 auto en
set network nic eth0 speed

set network nic eth0 speed {10 | 100}
Syntax Description

10

10 megabits per second

100

100 megabits per second

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to configure speed settings for a Network Interface card (NIC). This command controls the speed of the Ethernet connection in megabits per second. When used, this command disables auto negotiation.

Note Per the IEEE standard, 1000BASE-T (1 GB Ethernet) can only be enabled via auto-negotiation.

Note For the changes to take effect, the NIC will be reset, which will cause a temporary loss of network connectivity.

Examples
admin:set network nic eth0 speed 100
set network nic eth0 duplex

set network nic eth0 duplex {half | full}
Syntax Description

half

Enables half duplex

full

Enables full duplex

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to configure duplex settings of the Ethernet connection. When used, it will disable auto negotiation.

Note For the changes to take effect, the NIC will be reset, which will cause a temporary loss of network connectivity.

Examples
admin:set network nic eth0 duplex half
set network pmtud

set network pmtud {enable | disable}
Syntax Description

enable

Enables Path MTU Discovery

disable

Disables Path MTU Discovery

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to enable or disable Path MTU Discovery.

Note For the changes to take effect, this command causes a temporary loss of network connectivity.

Examples
admin:set network pmtud enable
          ***   W A R N I N G   ***
This will cause the system to temporarily lose network connectivity
          Do you want to continue?
Enter "yes" to continue or any other key to abort
yes
executing...
set network status eth0

set network status eth0 {up | down}
Syntax Description

up

Sets state of eth0 to up.

down

Sets state of eth0 to down.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the state of the Ethernet interface eth0 to up or down.

Examples
admin:set network restore eth0 down
***   W A R N I N G   ***
This will cause the system to temporarily lose network connectivity
Continue (y/n) ?y
Executed command unsuccessfully
status is down
set password admin

set password admin
Syntax Description

None

Command Modes

Admin

Command History

Command

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set a new administrator password.

Note Passwords must be at least 6 characters, but not more than 64 characters in length, and can contain upper and lower case alphanumeric characters, and underscore and dash characters. The password should not be a word found in the dictionary. The following passwords are not allowed: apache, daemon, nobody, operator, and shutdown. Do not use your personal or account names or any variation of them.
admin:set password admin
Please enter the old password: ******
Please enter the new password: ********
Re-enter new password to confirm: ********
Executed command unsuccessfully
set snmp trapdest add

set snmp trapdest add version username destination [level] [passphrase] [engineID]
Syntax Description

version

Defines Simple Network Management Protocol (SNMP) version, either 3 or 2c

username

Defines SNMP username (version 3) or community string (version 2c)

destination

Destination host, using the following format: n.n.n.n[:port}

level

SNMP version 3 only: defines level. Available values for this field are:

•authNoPriv (default)

•authPriv

•noauthNoPriv

passphrase

SNMP version 3 only: defines the user passphrase. The passphrase must contain at least 8 characters.

engineID

SNMP version 3 only: defines engine ID to use for trap.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set a Simple Network Management Protocol (SNMP) trap destination.

Examples
admin:set snmp trapdest add 3 trapusr 64.101.180.49:162 authnopriv trappass 
0x8000DEECAFE8111BEEFADE
Successfully added trap destination
set snmp trapdest del

set snmp trapdest del
Syntax Description

None

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to delete a Simple Network Management Protocol (SNMP) trap destination.

Examples
admin:set snmp trapdest del
1) Host = 64.101.180.49:162 (Version 3)
     Version 3 Options:
            User = TimTrap               PW   = authpriv
           Level = authnopriv            Hash = md5
        EngineID = 0x80001f8803001a6406bc16
  2) Host = 64.101.180.49 (Version 3)
     Version 3 Options:
            User = TimTrap2              PW   = authpriv
           Level = authnopriv            Hash = md5
        EngineID = 0x80001f8803001a6406bc16
  3) Host = 64.101.180.49:162 (Version 3)
     Version 3 Options:
            User = trapusr               PW   = trappass
           Level = authnopriv            Hash = md5
        EngineID = 0x8000DEECAFE8111BEEFADE
  Enter which trap number to delete: 2
Successfully deleted trap destination
set snmp user add

set snmp user add version username access [level] [passphrase]
Syntax Description

version

Defines Simple Network Management Protocol (SNMP) version, either 3 or 2c

username

Defines SNMP username (version 3) or community string (version 2c). User names can be from 1 to 32 characters.

access

Defines which SNMP tasks can be accessed; values are:

•r (read)

•w (write)

•rw (read and write)

level

SNMP version 3 only: defines level. Available values for this field are:

•authNoPriv (default)

•authPriv

•noauthNoPriv

passphrase

SNMP version 3 only: defines the user passphrase. The passphrase must contain at least 8 characters.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to add a new user or community to SNMP. You can add up to eight SNMP users.

Note For SNMP version 3, hash will always be MD5 and encryption will be DES.

Examples
admin:set snmp user add 3 testusr rw authpriv testpass
Successfully added user
admin:set snmp user add 2c test_RO r
Successfully added user
set snmp user del

set snmp user del version username
Syntax Description

version

Defines Simple Network Management Protocol (SNMP) version, either 3 or 2c

username

Defines SNMP username (version 3) or community string (version 2c)

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to delete a user or community from SNMP.

Note For SNMP version 3, hash will always be MD5 and encryption will be DES.

Examples
admin:set snmp user del 3 tim
Successfully deleted user
admin:set snmp user del 2c test_RO
Successfully deleted user
set syslog facility

set syslog facility facility
Syntax Description

facility

Defines default syslog message facility. Values are from local0 to local7.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the default facility used for syslog messages.

Examples
admin: set syslog facility local1
Setting to local1 facility
set syslog heartbeat facility

set syslog heartbeat facility facility
Syntax Description

facility

Defines default syslog heartbeat facility. Values are from local0 to local7.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the default facility used for heartbeat messages.

Examples
admin:set syslog heartbeat facility local1
Setting to local1 facility
set syslog heartbeat interval

set syslog heartbeat interval interval
Syntax Description

interval

Defines interval in minutes from 0 to 2880. If set to 0, heartbeat messages will be disabled.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the syslog heartbeat interval in minutes. Setting this command to 0 disables syslog heartbeat messages.

Examples
admin:set syslog heartbeat interval 10
set syslog heartbeat msg

set syslog heartbeat msg text
Syntax Description

text

Text string within double quotes ("text") for heartbeat messages.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to define the syslog heartbeat message text.

Examples
admin:set syslog heartbeat msg "example message"
Setting message to "example message"
set syslog heartbeat severity

set syslog heartbeat severity level
Syntax Description

level

Defines the level of severity for syslog heartbeat messages. Available choices are from 0 (emergency) to 7(debug).

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the level of severity for syslog heartbeat messages.

Examples
admin:set syslog heartbeat severity 7
Setting severity to 7
set syslog timezone

set syslog timezone zone
Syntax Description

zone

Defines the timezone for syslog message timestamps. Choices are:

local: local timezone

gmt: Greenwich mean time

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the timezone used for syslog message timestamps.

Examples
admin:set syslog timezone gmt
set syslog version

set syslog version version
Syntax Description

version

Defines the syslog message output format version. Choices are:

0: CiscoLog versions 1.1 format

1: RFC Syslog Protocol Version 1 format

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the system message output format version.

Examples
admin:set syslog version 0
Setting to 0, the CiscoLog v1.1 format
set timezone

set timezone timezone
Syntax Description

timezone

Enter the appropriate text string or timezone code for the zone you want to configure. Use the show timezone list command to display a complete list of available timezone codes.

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set a new timezone value. This sets system time on CTRS server.

Examples
admin:set timezone America/Los_Angeles
Using timezone: America/Los_Angeles
A system restart is required
Change timezone and reboot (yes|no)? yes
Executed command successfully
set videoquality

set videoquality {highest | higher | high | medium | low | lower | lowest}
Syntax Description

highest

Highest Detail, Best Motion: 1080p

higher

Highest Detail, Better Motion: 1080p

high

Highest Detail, Good Motion: 1080p

medium

High Detail, Best Motion: 720p

low

High Detail, Better Motion: 720p

lower

High Detail, Good Motion: 7200p

lowest

High Detail, Limited Motion: 720p (Lite)

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the video recording quality.

Examples
admin:set videoquality higher
set web-security

set web-security orgunit orgname locality state country [alternatehostname]
Syntax Description

orgunit

Defines organization unit

orgname

Defines organizational name

locality

Defines location of organization

state

Defines state of organization

country

Defines country of organization

alternatehostname

If present, defines alternate host name with SubjectAlternativeName extension with a DNS: Prefix

o

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to create a new "Tomcat" certificate for HTTPS access to Cisco Unified Communications Manager.

Note You must restart the "Cisco Tomcat" service for the new certificate to take effect.

Examples
admin:set web-security mydept mycorp SanJose CA US
Successfully generated self signed certificate for tomcat
set workingdir activelog

set workingdir activelog directory
Syntax Description

directory

Valid subdirectory of activelog

o

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the CLI working directory for activelog. Only a valid subdirectory can be used. Do not use a forward slash (/) or a period (.) in front of the directory name. Use the show workingdir command to confirm this command worked.

Examples
admin:set workingdir activelog syslog
set workingdir inactivelog

set workingdir inactivelog directory
Syntax Description

directory

Valid subdirectory of inactivelog

o

Command Modes

Admin

Command History

Release

Modifications

1.6

This command was first documented.

Usage Guidelines

Use this command to set the CLI working directory for inactivelog. Only a valid subdirectory can be used. Do not use a forward slash (/) or a period (.) in front of the directory name. Use the show workingdir command to validate.

Examples
admin:set workingdir inactivelog syslog