Cisco TelePresence Multipoint Switch Release 1.8 Command Reference
CTMS Set Commands
Downloads: This chapterpdf (PDF - 618.0KB) The complete bookPDF (PDF - 3.69MB) | Feedback

CTMS Set Commands

Table Of Contents

CTMS Set Commands

set account enable

set account name

set accountlocking

set bad_ep_detect

set cli pagination

set commandcount

set cuvcdialrepeatinterval

set cuvcdialrepeattime

set damping

set eventcontrol announcement

set eventcontrol entry rx audio

set eventcontrol entry rx both

set eventcontrol entry rx video

set eventcontrol entry source

set eventcontrol entry tx audio

set eventcontrol entry tx both

set eventcontrol entry tx video

set eventcontrol lock

set eventcontrol map

set eventcontrol rx audio

set eventcontrol rx both

set eventcontrol rx video

set eventcontrol tx audio

set eventcontrol tx both

set eventcontrol tx video

set eventcontrol unlock

set eventcontrol videoswitch

set eventcontrol webgui boardroom

set eventcontrol webgui directorctrl

set feedbackwaitbasetime

set holdresume

set lateendmins

set logging

set ltrp

set meetingtermination

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 restore

set network status eth0

set password admin

set password age maximum

set password age minimum

set password complexity character

set password complexity minimum-length

set password expiry maximum-age

set password expiry minimum-age

set password expiry user maximum-age

set password expiry user minimum-age

set password history

set password inactivity

set password user admin

set password user security

set rtpsleep

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 t1mode

set threshold

set timezone

set web-security

set workingdir activelog

set workingdir inactivelog


CTMS Set Commands


October 2011

This chapter contains the following Cisco TelePresence Multipoint Switch (CTMS) set CLI commands. For information on how to use CTMS CLI commands, refer to "Using Cisco TelePresence Multipoint Switch CLI Commands" chapter in this manual.

set account name

set accountlocking

set bad_ep_detect

set cli pagination

set commandcount

set cuvcdialrepeatinterval

set cuvcdialrepeattime

set damping

set eventcontrol announcement

set eventcontrol entry rx audio

set eventcontrol entry rx both

set eventcontrol entry rx video

set eventcontrol entry source

set eventcontrol entry tx audio

set eventcontrol entry tx both

set eventcontrol entry tx video

set eventcontrol lock

set eventcontrol map

set eventcontrol rx audio

set eventcontrol rx both

set eventcontrol rx video

set eventcontrol tx audio

set eventcontrol tx both

set eventcontrol tx video

set eventcontrol unlock

set eventcontrol videoswitch

set eventcontrol webgui boardroom

set eventcontrol webgui directorctrl

set feedbackwaitbasetime

set holdresume

set lateendmins

set logging

set ltrp

set meetingtermination

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 restore

set network status eth0

set password admin

set password age maximum

set password age minimum

set password complexity character

set password complexity minimum-length

set password expiry maximum-age

set password expiry minimum-age

set password expiry user maximum-age

set password expiry user minimum-age

set password history

set password inactivity

set password user admin

set password user security

set rtpsleep

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 t1mode

set threshold

set timezone

set web-security

set workingdir activelog

set workingdir inactivelog


Note For information about using the CTMS Administration software, refer to the Cisco TelePresence Multipoint Switch Release 1.8 Administration Guide at the following URL:
http://www.cisco.com/en/US/products/ps7315/prod_maintenance_guides_list.html


set account enable

set account enable user-id

Syntax Description

user-id

Name of the user account.


Command Modes

Admin

Command History

Release
Modifications

1.8

This command was first documented.


Usage Guidelines

Use this command to enable a user account that has been disabled due to password inactivity.

Examples

admin:set account enable test
Enabling the account 'test' with current settings....
.....
Successfully enabled account 'test'
 
   

set account name

set account name name

Syntax Description

name

Name of the administrative account.


Command Modes

Admin

Command History

Release
Modifications

1.5

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 accountlocking

set accountlocking {disable | enable | unlocktime seconds}

Syntax Description

disable

Disable account locking

enable

Enable account locking

unlocktime seconds

The number of seconds an account is disabled. Valid values comprise greater than 300 seconds, but less than 3600 seconds (60 minutes).


Command Modes

Admin

Command History

Release
Modifications

1.8

This command was first documented.


Usage Guidelines

Use this command to enable and disable the account locking feature. Account locking, when enabled, disables an administrative account if a user incorrectly enters his or her credentials three times.

Examples

set accountlocking enable
 
   
 
   
 
   

set bad_ep_detect

set bad_ep_detect {enable | disable}

Syntax Description

enable

Enables bad endpoint detection feature; if detected, CTMS will drop a bad endpoint from conferences

disable

Disables bad endpoint detection feature.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.

1.8

This command was removed and is no longer supported in version 1.8.


Usage Guidelines

Use this command to either enable or disable the bad endpoint detection feature. If this command is set to enable, bad source endpoints will be dropped from conferences; if set to disable, the bad endpoint will be kept in the meeting.

Examples

admin:set bad_ep_detect disable
Telepresence Multipoint Switch; drop bad endpoint: disable
 
   

set cli pagination

set cli pagination {on | off}

Syntax Description

on

Enable CLI pagination

off

Disable CLI pagination


Command Modes

Admin

Command History

Release
Modifications

1.8

This command was first documented.


Usage Guidelines

Use this command to enable or disable CLI pagination. When CLI pagination is enabled, CLI output pauses to display one page at a time.

Examples

set cli pagination on
 
   
 
   
 
   

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.1

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 cuvcdialrepeatinterval

set cuvcdialrepeatinterval time

Syntax Description

time

Length of time, in seconds, that the CTMS waits between redialing the CUVC. The default is 30.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.


Usage Guidelines

Use this command to configure the time (in seconds) for CTMS to redial a CUVC participant.

Examples

admin: set cuvcdialrepeatinterval 30

set cuvcdialrepeattime

set cuvcdialrepeattime number

Syntax Description

number

Number of times CTMS will redial a CUVC meeting participant. The default is 50.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.


Usage Guidelines

Use this command to configure the number of times CTMS will redial a CTMS meeting participant.

Examples

admin: set cuvcdialrepeattime 10

set damping

set damping {exitLecture | lecture | override | rollCall | switch | vip} {fast | medium | slow}

Syntax Description

exitLecture

Disable lecture. This damping time refers to how long someone other than the lecturer must speak to reset the lecturer. After the configured time elapses, the meeting returns to its standard switching policy. Another participant can become lecturer after speaking for the amount of time configured with the set  damping lecture command.

fast is .5 to 1.5 seconds; medium is 1.5 to 2.5 seconds; slow is 2.5 to 3.5 seconds.

lecture

Auto Lecture Mode. This damping time refers to how long someone must speak to become the lecturer when Auto Lecture Mode is enabled.

fast is 30 seconds; medium is 60 seconds; slow is 90 seconds.

override

VIP override. This damping time refers to how long a meeting participant must speak to override the VIP source.

fast is .5 to 1.5 seconds; medium is 1.5 to 2.5 seconds; slow is 2.5 to 3.5 seconds.

rollCall

Rollcall. This damping time refers to how long each site is seen by the lecturer when Auto Lecture Mode is enabled.

fast is 5 seconds; medium is 10 seconds; slow is 15 seconds.

switch

Switching. This damping time refers to how long meeting participants must speak to be switched in as active speakers.

fast is .5 to 1.5 seconds; medium is 1.5 to 2.5 seconds; slow is 2.5 to 3.5 seconds.

vip

VIP return. This damping time refers to how long the VIP source must speak to be switched back in after being overridden by another meeting participant.

fast is .5 to 1.5 seconds; medium is 1.5 to 2.5 seconds; slow is 2.5 to 3.5 seconds.


Defaults

All damping timers are set to medium.

Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.

1.7

Keywords modified. Before release 1.7, keywords were s, l, d, v, o, and r. The functionality related to these options is still available, but these are the new keywords and their equivalents in the syntax for releases before 1.7:

exitLectured

lecturel

overrideo

rollCallr

switchs

vipv


Usage Guidelines

Use this command to set damping time values for screen switching. Damping is the amount of time that a screen is shown under various conditions.

The lecture, exitLecture, and rollCall keywords apply to Auto Lecture Mode. The vip and override keywords apply to VIP Mode. You can enable either mode for an active meeting from the CTMS administrative GUI (go to Meetings Management > Active Meetings).

Auto Lecture Mode and VIP Mode are mutually exclusive. You can enable only one or the other for any one meeting.


Note The system does not accept a "dash character" (-) as syntax for the set damping command. For example, the system would consider this input to be invalid:

admin: set damping exitLecture -99


Examples

admin:set damping switch fast

set eventcontrol announcement

set eventcontrol announcement {enable | disable} room_DN [meeting_ID]

Syntax Description

enable

Enables the video announcement on the CTMS endpoint with the specified directory number.

disable

Disables the video announcement on the CTMS endpoint with the specified directory number.

room_DN

Room directory number of a destination endpoint

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.

1.7

The meeting_ID argument is mandatory. In release 1.6, the argument is optional.


Usage Guidelines

This command enables or disables the video announcement for an active destination endpoint with the specified directory number.

The setting of the Video Announce attribute, which is available in the Default Meetings screen of the CTMS Web UI, determines the effectiveness of the set eventcontrol announcement command. Table 4-1 outlines likely scenarios with the Video Announce attribute and the set eventcontrol announcement command, and the results.

Table 4-1 Effect of Video Announcement Attribute on set eventcontrol announcement Command 

Video Announcement Attribute Setting
set eventcontrol announcement Command Setting
Result

No

For example:
set eventcontrol announcement enable 12003

No effect. For example, if endpoint 13695 joins a meeting, the addition of this endpoint is not announced on endpoint 12003.

Yes

For example:
set eventcontrol announcement disable 12003

Effective. For example, if endpoint 13695 joins a meeting, the addition of this endpoint is not announced on endpoint 12003.


Examples

admin:set eventcontrol announcement disable 4081245678 9100048202

set eventcontrol entry rx audio

set eventcontrol entry rx audio {enable | disable} meeting_ID

Syntax Description

enable

If enabled, new participants will receive audio on meeting entry.

disable

If disabled, new participants will not receive audio on meeting entry.

meeting_ID

CTMS meeting identification number.


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether new participants to a CTMS meeting receive audio on entering the meeting.

Examples

admin:set eventcontrol entry rx audio disable 1234567890

set eventcontrol entry rx both

set eventcontrol entry rx both {enable | disable} meeting_ID

Syntax Description

enable

If enabled, new participants will receive audio and video on meeting entry.

disable

If disabled, new participants will not receive audio or video on meeting entry.

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether new participants to a CTMS meeting receive audio and video on entering the meeting.

Examples

admin:set eventcontrol entry rx both disable 1234567890

set eventcontrol entry rx video

set eventcontrol entry rx video {enable | disable} meeting_ID

Syntax Description

enable

If enabled, new participants will receive video on meeting entry.

disable

If disabled, new participants will not video on meeting entry.

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether new participants to a CTMS meeting receive video on entering the meeting.

Examples

admin:set eventcontrol entry rx video disable 1234567890

set eventcontrol entry source

set eventcontrol entry source enable {DN | DN/seg} meeting_ID

set eventcontrol entry source disable meeting_ID

Syntax Description

enable

If enabled, new participants will be forced to see the DN specified as the source defined (by meeting ID) source. That source will be blocked.

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

CTMS meeting identification number

disable

If disabled, new participants will not be forced to see defined (by meeting ID) source.


Defaults

Disabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether new participants to a CTMS meeting will be forced to see a particular defined source. The source is defined by the meeting_ID parameter. The source is locked to the endpoint for the remainder of the meeting or unless the set eventcontrol unlock command is entered.

Examples

admin:set eventcontrol entry source enable 4082230492/L 1234567890

set eventcontrol entry tx audio

set eventcontrol entry tx audio {enable | disable} meeting_ID

Syntax Description

enable

When joining a meeting, audio streams coming from this endpoint will be enabled.

disable

When joining a meeting, audio streams coming from this endpoint will be disabled.

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether audio streams from this participant will be transmitted when this endpoint joins a meeting.

Examples

admin:set eventcontrol entry tx audio disable 1234567890

set eventcontrol entry tx both

set eventcontrol entry tx both {enable | disable} meeting_ID

Syntax Description

enable

When joining a meeting, audio and video streams coming from this endpoint will be enabled.

disable

When joining a meeting, audio and video streams coming from this endpoint will be disabled.

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether audio and video streams from this participant will be transmitted when this endpoint joins a meeting.

Examples

admin:set eventcontrol entry tx both disable 1234567890

set eventcontrol entry tx video

set eventcontrol entry tx video {enable | disable} meeting_ID

Syntax Description

enable

When joining a meeting, video streams coming from this endpoint will be enabled.

disable

When joining a meeting, video streams coming from this endpoint will be disabled.

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable whether video streams from this participant will be transmitted when this endpoint joins a meeting.

Examples

admin:set eventcontrol entry tx video disable 1234567890

set eventcontrol lock

set eventcontrol lock {source DN/seg} {destination DN/seg} [meeting_ID]

Syntax Description

source DN

Source CTS as identified by its defined access number (directory number)

seg

Indicates the segment in a three-segment CTS (R: right, C: center, L: left) or a one-segment CTS (C: center).

destination DN

Destination CTS as identified by its defined access number (directory number)

meeting_ID

(Optional) CTMS meeting identification number


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to map and lock between CTS segments.

The configured source CTS segment always displays on the configured destination CTS segment until the segment is unlocked, either source or destination endpoint leaves the meeting, the meeting ends, or you use the set eventcontrol lock command again to move the lock.

When mapping and locking a single-segment CTS endpoint, you must still specify the segment, which in this case is C (center segment).

For information on unlocking CTS segments, see the set eventcontrol unlock command.

Examples

This command maps and locks the left segment of CTS source 4081245678 to the right segment of CTS destination 4088762233:

admin: set eventcontrol lock 4081245678/L 4088762233/R 1234567890
 
   

This command maps and locks the left segment of CTS source 4081245666 to the one-segment CTS destination 4088651234:

admin: set eventcontrol map 4081245666/L 4088651234/C
 
   

set eventcontrol map

set eventcontrol map {source DN/seg} {destination DN/seg} [meeting_ID]

Syntax Description

source DN

Source CTS as identified by its defined access number (directory number)

seg

Indicates the segment in a three-segment CTS (R: right, C: center, L: left) or a one-segment CTS (C: center).

destination DN

Destination CTS as identified by its defined access number (directory number)

meeting_ID

(Optional) CTMS meeting identification number


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to map between segments, meaning CTMS sets a source CTS segment to be seen on a destination CTS segment and be seen there when they become active speaker.

When mapping a single-segment CTS endpoint, you must still specify the segment, which in this case is C (center segment).

Examples

This command maps the left segment of CTS source 4081245678 to the right segment of CTS destination 4088762233:

admin: set eventcontrol map 4081245678/L 4088762233/R 1234567890
 
   

This command maps the left segment of CTS source 4081245666 to the one-segment CTS destination 4088651234:

admin: set eventcontrol map 4081245666/L 4088651234/C
 
   

set eventcontrol rx audio

set eventcontrol rx audio {enable | disable} {DN | DN/seg} [meeting_ID]

Syntax Description

enable

Immediately enables the audio stream received by a segment or entire endpoint.

disable

Immediately disables the audio stream received by a segment of an entire endpoint

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

(Optional) CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to immediately enable or disable the audio stream being received by a segment or endpoint.

Examples

admin: set eventcontrol rx audio disable 4081245678/L

set eventcontrol rx both

set eventcontrol rx both {enable | disable} {DN | DN/seg} [meeting_ID]

Syntax Description

enable

Immediately enables the audio and video received by a segment or an entire endpoint.

disable

Immediately disables the audio and video received by a segment or an entire endpoint.

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

(Optional) CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to immediately enable or disable the audio and video streams being received by a segment or endpoint.

Examples

admin: set eventcontrol rx both disable 4081245678/L

set eventcontrol rx video

set eventcontrol rx video {enable | disable} {DN | DN/seg} [meeting_ID]

Syntax Description

enable

Immediately enables the video received by a segment or an entire endpoint.

disable

Immediately disables the video received by a segment or an entire endpoint.

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

(Optional) CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to immediately enable or disable the video stream being received by a segment or endpoint.

Examples

admin: set eventcontrol rx video disable 4081245678/L

set eventcontrol tx audio

set eventcontrol tx audio {enable | disable} {DN | DN/seg} [meeting_ID]

Syntax Description

enable

Immediately enables the audio sent by a segment or endpoint.

disable

Immediately disables the audio sent by a segment or endpoint.

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

(Optional) CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to immediately enables or disable the audio stream being sent by a segment or endpoint.

Examples

admin: set eventcontrol tx audio disable 4081245678/L

set eventcontrol tx both

set eventcontrol tx both {enable | disable} {DN | DN/segment} [meeting_ID]

Syntax Description

enable

Immediately enables the audio and video sent by a segment or endpoint.

disable

Immediately disables the audio and video sent by a segment or endpoint.

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

(Optional) CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to immediately enable or disable the audio and video streams being sent by a segment or endpoint.

Examples

admin: set eventcontrol tx both disable 4081245678/L

set eventcontrol tx video

set eventcontrol tx video {enable | disable} {DN | DN/segment} [meeting_ID]

Syntax Description

enable

Immediately enables video sent by a segment or endpoint.

disable

Immediately disables video sent by a segment or endpoint.

DN

CTS as identified by its defined access number (directory number)

DN/seg

CTS access number and segment. The seg value indicates the CTS segment in a three-segment system:

R: right

C: center

L: left

meeting_ID

(Optional) CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to immediately enable or disable the video stream being sent by a segment or endpoint.

Examples

admin: set eventcontrol tx video disable 4081245678/L

set eventcontrol unlock

set eventcontrol unlock [source DN/seg] {destination DN/seg} [meeting_ID]

Syntax Description

source DN

(Optional) Source CTS as identified by its defined access number (directory number)

destination DN

Destination CTS as identified by its defined access number (directory number)

seg

Indicates the segment in a three-segment CTS (R: right, C: center, L: left) or a one-segment CTS (C: center).

meeting_ID

(Optional) CTMS meeting identification number


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to unlock already mapped and locked CTS segments during CTS conferences.

The locked source CTS segment displays on the configured destination CTS segment until the segment is unlocked, either source or destination endpoint leaves the meeting, or the meeting ends.

When unlocking a single-segment CTS endpoint, you must still specify the segment, which in this case is C (center segment).

For information on mapping and locking segments, see the set eventcontrol lock command.

Examples

This command unlocks the right segment of destination CTS 4088762233 from the left segment of source CTS 4081245678:

admin: set eventcontrol unlock 4081245678/L 4088762233/R 1234567890
 
   

This command unlocks the one-segment CTS destination 4088651234 from the left segment of CTS source 4081245666:

admin: set eventcontrol map 4081245666/L 4088651234/C
 
   

set eventcontrol videoswitch

set eventcontrol videoswitch {enable | disable} meeting_ID

Syntax Description

enable

Enables video voice-activated switching for the meeting.

disable

Disables video voice-activated switching for the meeting.

meeting_ID

CTMS meeting identification number


Defaults

Enabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to enable or disable video voice-activated switching for a meeting.

Examples

admin:set eventcontrol videoswitch disable 1234567890

set eventcontrol webgui boardroom

set eventcontrol webgui boardroom {enable | disable}

Syntax Description

enable

Enables the boardroom Web GUI.

disable

Disables the boardroom Web GUI.


Defaults

Disabled

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

When you enter set eventcontrol webgui boardroom enable, Event Controls appears under the Meetings Management in CTMS GUI. From there, you can set the boardroom and presenters for an active meeting.

Examples

admin:set eventcontrol webgui boardroom enable

set eventcontrol webgui directorctrl

set eventcontrol webgui directorctrl {enable | disable}

Syntax Description

enable

Enables Director Control in the Web GUI.

disable

Disables Director Control in the Web GUI.


Defaults

Disabled

Command Modes

Admin

Command History

Release
Modifications

1.7

This command was first introduced.


Usage Guidelines

When you enter set eventcontrol webgui directorctrl enable, Director Control appears for active meetings in the Manage section of the Web GUI. From the Web GUI, you can set what rooms and room segments see and hear in an active meeting.

Examples

admin:set eventcontrol webgui directorctrl enable

set feedbackwaitbasetime

set feedbackwaitbasetime value

Syntax Description

value

Sets RTP feedback base wait time in milliseconds. Values are from 30 to 400. Default is 150.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.


Usage Guidelines

Use this command to set RTP feedback base wait time in milliseconds. Real feedback wait time is equal to the maximum latency value plus the feedback wait base time.

Examples

admin:set feedbackwaitbasetime 200

set holdresume

set holdresume {true | false}

Syntax Description

true

Enables server side hold/resume feature for static and scheduled conferences. (User sees an hour glass icon on the display.)

false

Disables server side hold/resume feature for static and scheduled conferences. (User sees a blank screen.)


Command Modes

Admin

Command History

Release
Modification

1.1

This command was first documented.


Usage Guidelines

Use this command to enable or disable server side hold/resume feature for static and scheduled conferences.


Note If hold/resume is disabled through the set holdresume false command, your system will be impacted in the following way:

For a best-effort meeting with only secure endpoints, non-secure endpoints can not join.

For a best-effort meeting with only non-secure endpoints, secure endpoints can not join.

When hold/resume is enabled through the set holdresume true command, the above-mentioned restrictions are removed immediately.


Examples

admin: set holdresume true

set lateendmins

set latenedmins value

Syntax Description

value

Number of minutes after which a conference will be terminated when the meeting exceeds the scheduled end time.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.


Usage Guidelines

Use this command to define the number of minutes after which a conference will be terminated when the meeting exceeds the scheduled end time.


Note This command takes effect when CTMS is registered with Cisco TelePresence Manager but not supported by Cisco TelePresence Manager.


Examples

admin: set lateendmins 3

set logging

set logging {enable | disable}

Syntax Description

enable

Enables logging.

disable

Disables logging.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.


Usage Guidelines

Use this command to either enable or disable logging.

Examples

admin:set logging enable

set ltrp

set ltrp {enable | disable}

Syntax Description

enable

Enables Long Term Reference Picture (LTRP) feature.

disable

Disables Long Term Reference Picture (LTRP) feature.


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.


Usage Guidelines

Use this command to enable or disable the Long Term Reference Picture (LTRP) feature.

Examples

admin:set ltrp enable
 
   

set meetingtermination

set meetingtermination {true | false}

Syntax Description

true

Enables conference termination for scheduled conferences.

false

Disables conference termination for scheduled conferences.


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.

1.6

Syntax changed from set conferencetermination to set meetingtermination.


Usage Guidelines

Use this command to either enable or disable conference termination for scheduled conferences.


Note This command takes effect when CTMS is registered with Cisco TelePresence Manager but not supported by Cisco TelePresence Manager.


Examples

admin:set meetingtermination true
 
   

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.5

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 server. Values for address are valid dotted decimal IP addresses.

secondary address

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


Command Modes

Admin

Command History

Release
Modifications

1.1

This command was first documented.


Usage Guidelines

Use this command to define new IP addresses for primary or secondary DNS server 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 CTMS waits before considering a Domain Name System (DNS) query to have failed. Value indicates number of seconds.

attempts value

Defines the number of times CTMS 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.5

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 CTMS resides


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.


Usage Guidelines

Use this command to set the domain of the CTMS.

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.5

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 remove 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.5

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.5

This command was first documented.


Usage Guidelines

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

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.1

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 reboots 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.5

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.5

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 CTMS 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 auto negotiation for 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 set Path MTU Discovery as enabled or disabled.


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 restore

set network restore eth0 ip_address network_mask gateway

Syntax Description

ip address

Defines value for static IP address.

network_mask

Defines value for network mask

gateway

Defines IP address of primary gateway


Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

Use this command to configure the specified Ethernet port with a static IP address. A temporary loss of network connectivity will occur while the network is being restarted with the new configuration.


Note It is imperative that the original Ethernet port settings be reconfigured after this command using other CLI `set network ...'commands.


Examples

admin:set network restore eth0   10.94.150.108   255.255.255.0   10.94.150.1
*** WARNING ***
Only use this command in the event that all other CLI
'set network ...' commands have failed to restore network
connectivity to an Ethernet port. This command wipes out all
previous Ethernet and Network Fault Tolerance settings.
The specified Ethernet port is configured with a
minimal static IP address configuration.
 
   
It's imperative that the original Ethernet port settings be 
reconfigured AFTER this command using other CLI 'set network ...'
commands.
 
   
This command will restart the networking on this host.
 
   
Continue (y/n)?y
 
   
Shutting down interface eth0:  [  OK  ]
Shutting down loopback interface:  [  OK  ]
Setting network parameters:  [  OK  ]
Bringing up loopback interface:  [  OK  ]
Bringing up interface eth0:  [  OK  ]

set network status eth0

set network status eth0 {up | down}

Syntax Description

up

Enable the eth0 network interface.

down

Disable the eth0 network interface.


Command Modes

Admin

Command History

Release
Modifications

1.8

This command was first documented.


Usage Guidelines

Use this command to enable or disable the CTMS Ethernet interface.


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


Examples

admin:set network status eth0 up
 
   
 
   
 
   
 
   

set password admin

set password admin

Syntax Description

None

Command Modes

Admin

Command History

Command
Modifications

1.1

This command was first documented.

1.8

This command was removed and is no longer supported in version 1.8.


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 the underscore and dash characters. The following usernames are not allowed: apache, daemon, nobody, operator, and shutdown.

Examples

admin:set password admin
Please enter the old password: ******
Please enter the new password: ********
Re-enter new password to confirm: ********
 
   

set password age maximum

set password age maximum days

Syntax Description

days

The number of days before a password must be changed.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command modifies the value of the maximum password age for Cisco Unified CM OS admin accounts in days.

Acceptable values for maximum password age should be equal to or greater than 10 days but less than 3650 days (10 years).

Examples

admin:set password age maximum 60
 
   
 
   
 
   

set password age minimum

set password age minimum days

Syntax Description

days

The number of days before a password can be changed.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command modifies the value of the minimum password age for Cisco Unified CM OS admin accounts in days.

Acceptable values for minimum password age should be equal to or greater than 0 days but less than or equal to 10 days.

Examples

admin:set password age minimum 7
 
   
 
   
 
   

set password complexity character

set password complexity character {enable | disable}

Syntax Description

enable

Enable password complexity

disable

Disable password complexity


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command enables or disables password complexity rules for the type of characters in a password.


Note You must change the passwords for the existing Cisco Unified CM OS accounts for the password complexity rules to be effective.


When enabled, the passwords will need to following guidelines:

1. It must have at least one lower-case character.

2. It must have at least one uppercase, one digit and one special character.

3. All of the adjacent characters on the keyboard will not be accepted.

4. Any of the previous ten passwords cannot be reused.

5. The admin user password can only be changed only once in 24 hours.

A violation of any of the above rules will result in a failure.

Examples

admin:set password complexity character enable
 
   

set password complexity minimum-length

set password complexity minimum-length length

Syntax Description

length

The minimum number of characters required for all passwords.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command modifies the value of the minimum password length for Cisco Unified CM OS accounts.

Acceptable values should be equal to or greater than 8.


Note Use this command only after enabling the character complexity of passwords.


Examples

admin:set password complexity minimum-length 8
 
   
 
   
 
   

set password expiry maximum-age

set password expiry maximum-age {enable | disable}

Syntax Description

enable

Enable password expiration upon reaching maximum age.

disable

Disable password expiration.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command enables or disables the password expiry maximum-age feature for OS accounts.

This command sets the value of maximum password age to 3650 days (10 yrs) for Unified CM OS admin accounts.

Examples

admin:set password expiry maximum-age enable
 
   
 
   
 
   

set password expiry minimum-age

set password expiry minimum-age {enable | disable}

Syntax Description

enable

Enable password minimum age.

disable

Disable password minimum age.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command enables or disables the password expiry maximum-age feature for OS accounts.

This command sets the value of minimum password age to 1 day (24 hrs) for OS admin accounts.

Examples

admin:set password expiry minimum-age enable
 
   
 
   
 
   

set password expiry user maximum-age

set password expiry user maximum-age {enable | disable}

Syntax Description

enable

Enable password expiration upon reaching maximum age.

disable

Disable password expiration.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command enables or disables the password expiry maximum-age feature for a specific OS account.

Examples

admin:set password expiry user maximum-age enable
 
   
 
   

set password expiry user minimum-age

set password expiry user minimum-age {enable | disable}

Syntax Description

enable

Enable password minimum age.

disable

Disable password minimum age.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command enables or disables the password expiry minimum-age feature for a specific OS account.

admin:set password expiry user minimum-age enable
 
   
 
   

set password history

set password history number

Syntax Description

number

The number of historical passwords that will be retained for each account. Set this number to 0 to disable password history tracking.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command modifies the number of passwords that will be maintained in the history for OS admin accounts.


Note New passwords matching remembered passwords are not allowed.


Examples

admin:set password history 12
 
   

set password inactivity

set password {disable | enable | period days}

Syntax Description

enable

Enable password inactivity.

disable

Disable password inactivity

days

The number of days a password must be inactive before it is disabled.


Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

This command enables, disables or sets the password inactivity for the OS accounts.

Examples

admin:set password enable
 
   
 
   

set password user admin

set password user admin

Syntax Description

None

Command Modes

Admin

Command History

Command
Modifications

1.8

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 the underscore and dash characters. The following usernames are not allowed: apache, daemon, nobody, operator, and shutdown.

Examples

admin:set password user admin
Please enter the old password: ******
Please enter the new password: ********
Re-enter new password to confirm: ********
 
   

set password user security

set password user security

Syntax Description

None

Command Modes

Admin

Command History

Command
Modifications

1.8

This command was first documented.


Usage Guidelines

Use this command to set a new security password. The security password is used to authenticate other servers.

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 the underscore and dash characters. The following usernames are not allowed: apache, daemon, nobody, operator, and shutdown.

Examples

admin:set password security
Please enter the old password: ******
Please enter the new password: ********
Re-enter new password to confirm: ********
 
   

set rtpsleep

set rtpsleep value

Syntax Description

value

Defines value for RTP sleep. Values are from 1 to 5.


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.


Usage Guidelines

Use this command to set RTP sleep value.

Examples

admin:set rtpsleep 2
 
   
 
   

set snmp trapdest add

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

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 one of these formats:

n.n.n.n[:port}

hostname[:port]

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.

level

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

authNoPriv (default)

authPriv

noauthNoPriv


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.


Usage Guidelines

Use this command to set a Simple Network Management Protocol (SNMP) trap destination. These usage guidelines exist:

An SNMP version 3 user created using the set snmp user add command can have the same name as an SNMP version 3 trap destination user. The passwords for both users must be the same. The ability to use the same username and password is intended for SNMP administrators who also want to receive traps.

For SNMP version 3, we do not recommend configuring multiple CTMS servers with the same trap destination server and engine ID. A sample unsupported configuration is as follows:

CTMS server 1

admin:set snmp trapdest add 3 trap1 trapdest:162 trappassword 0x80001f881111222
 
   

CTMS server 2

admin:set snmp trapdest add 3 trap1 trapserver:162 trappassword 0x80001f881111222

Examples

admin:set snmp trapdest add 2c trapcomm 64.101.180.49:162
Successfully added trap destination

set snmp trapdest del

set snmp trapdest del

Syntax Description

None

Command Modes

Admin

Command History

Release
Modifications

1.5

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 [passphrase] [level]

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)

passphrase

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

level

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

authNoPriv (default)

authPriv

noauthNoPriv


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.


Usage Guidelines

Use this command to add a new user or community to SNMP. These usage guidelines exist:

You can create up to eight SNMP users.

Each SNMP user that you create must be unique. CTMS does not support multiple users with the same name, for example, "admin," but with different access privileges, passphrases, and security levels.

An SNMP version 3 user can have the same name as an SNMP version 3 trap destination user created using the set snmp trapdest add command. The passwords for both users must be the same. The ability to use the same username and password is intended for SNMP administrators who also want to receive traps.


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


Examples

admin:set snmp user add 3 testusr rw testpass authpriv
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 access [level]

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)

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


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.

1.8

access and level keywords have been removed.


Usage Guidelines

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


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


Examples

admin:set snmp user del 3 tim rw
Successfully deleted user
 
   
admin:set snmp user del 2c test_RO r
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.5

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.5

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 facility 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.5

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.5

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 msg 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.5

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.5

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.5

This command was first documented.


Usage Guidelines

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

Examples

admin:set syslog version 0

set t1mode

set t1mode {true | false}

Syntax Description

true

Enables T1 mode.

false

Disables T1 mode.


Defaults

True (enabled)

Command Modes

Admin

Command History

Release
Modifications

1.6

This command was first documented.


Usage Guidelines

With Extended Reach enabled, if a T1 endpoint joins a meeting, Conference Manager downgrades the meeting quality to 720p Lite. T1 endpoints are kept in the meeting, but pre-1.6 endpoints are dropped.

If you disable Extended Reach, Conference Manager rejects incoming T1 endpoints. Pre-1.6 endpoints are kept in the meeting.

Examples

admin:set t1mode false

set threshold

set threshold value

Syntax Description

value

Sets maximum burst packet threshold. Values are 0 to 200.


Command Modes

Admin

Command History

Release
Modifications

1.5

This command was first documented.


Usage Guidelines

Use this command to set the maximum burst packet threshold.

Examples

admin:set threshold 50
 
   

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.1

This command was first documented.


Usage Guidelines

Use this command to set a new timezone value.


Note The CTMS tracks two different timezone values. One, which this command sets, refers to the timezone in which the CTMS is physically located. The timzone value set in the administrative UI sets the timezone in which the administrator is located. Changing the system timezone using this command will not change the timezone displayed in the adminsitrative UI.


Examples

admin:set timezone Pac
 
   

set web-security

set web-security {orgunit orgname locality state} [country] [alternatehostname]

Syntax Description

orgunit

Specifies the organizational business unit or division.

orgname

Specifies the organization name.

city

Specifies the city in which the organization is located.

state

Specifies the state in which the organization is located.

country

Specifies the country in which the organization is located.

alternatehostname

Specifies an alternate name for the host when you generate the self-signed certificate.


Command Modes

Admin

Command History

Release
Modifications

1.8

This command was reintroduced.


Usage Guidelines

Use this command if you are denied access to the CTMS Administrative UI because of a revoked SSL certificate. This command generates a self-signed certificate for the web server (Tomcat) that enables you to regain access to the CTMS Administrative UI.

For each argument, you can enter upper- and lower-case alphabetical characters. Spaces between characters are not allowed.


Note When you set an alternate hostname with the set web-security command, self-signed certificates for Tomcat will contain the Subject Alternate Name extension with the alternate hostname specified. The CSR for Cisco Unified Communications Manager will contain Subject Alternate Name Extension with the alternate host name included in the CSR. You need to restart the "Cisco Tomcat" service for the new certificate to take effect.


Examples

admin:set web-security mybusinessunit Cisco SanJose CA US
Successfully generated self signed certificate for tomcat

set workingdir activelog

set workingdir activelog directory

Syntax Description

directory

Valid subdirectory of activelog


Command Modes

Admin

Command History

Release
Modifications

1.5

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 / or . in front of the directory name. Use the show workingdir command to validate.

Examples

admin:set workingdir activelog syslog
 
   

set workingdir inactivelog

set workingdir inactivelog directory

Syntax Description

directory

Valid subdirectory of activelog


Command Modes

Admin

Command History

Release
Modifications

1.5

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 / or . in front of the directory name. Use the show workingdir command to validate.

Examples

admin:set workingdir inactivelog syslog