Cisco Meeting Server MMP Command Reference 3 7
Cisco Meeting Server MMP Command Reference 3 7
Cisco Meeting Server MMP Command Reference 3 7
1 Introduction 6
1.1 How to use this Document 6
1.2 Accessing the MMP 8
1.2.1 Cisco Meeting Server 2000 8
1.2.2 Virtualized deployments (Cisco Meeting Server 1000 and specification
based VM servers) 8
1.2.3 Differences in specific commands between Cisco Meeting Server platforms 8
1.3 Transferring files to and from the MMP 9
1.3.1 Which files you see in the SFTP client 9
1.4 What MMP Commands are Available? 9
1.5 Writing and Completing MMP Commands 10
1.6 Reserved Ports 11
1.7 Summary of MMP additions and changes 11
2 Network Commands 13
2.1 Network Interface (iface) Commands 13
2.2 IP Commands 13
2.2.1 IPv4 commands 13
2.2.2 IPv6 commands 14
2.3 Network Diagnostic Commands 15
2.3.1 IPv4 network diagnostic commands 15
2.3.2 IPv6 network diagnostic commands 16
2.3.3 Packet capture 16
2.4 QoS/DSCP Commands 17
3 DNS Commands 19
4 Firewall Commands 21
5 LDAP Commands 23
6 Scheduler Commands 26
12 Miscellaneous Commands 62
12.1 Model 62
12.2 Meeting Server’s Serial Number 62
12.3 Message of the Day 62
12.4 Pre-login Legal Warning Banner 62
12.5 SNMP Commands 63
12.5.1 General information 63
12.5.2 SNMP v1/2c commands 63
12.5.3 SNMP v3 commands 64
12.5.4 SNMP trap receiver configuration 64
12.6 Downloading the System Logs 64
12.7 Generating and downloading the Log Bundle 65
12.8 Disk Space Usage 66
12.9 Backup and Restore System Configuration 66
12.10 Upgrading the Meeting Server 67
12.11 Resetting the Meeting Server 68
Cisco Trademark 13
Change History
Date Change Summary
March 16, 2023 New version for Cisco Meeting Server 3.7 software. See Summary of MMP
additions and changes.
August 23, 2022 New version for Meeting Server 3.6 software. See Summary of MMP additions
and changes.
April 20, 2022 New version for Meeting Server 3.5 software. See Summary of MMP additions
and changes.
December 21, 2021 Updated link for command description under TLS Certificate Verification sec-
tion.
December 15, 2021 New version for Meeting Server 3.4 software. See Summary of MMP additions
and changes.
August 24, 2021 New version for Meeting Server 3.3 software.
May 19, 2021 Updated the document with recommendations for Medium OVA Expressway.
April 16, 2021 Moved the MTU for an Interface command under section 2.1 Network Inter-
face (iface) Commands. Updated the note regarding MTU information.
April 09, 2021 New version for Meeting Server 3.2 software.
March 16, 2021 Updated the document for short term credentials on the Meeting Server being
a fully supported feature.
1 Introduction
The Cisco Meeting Server software can be hosted on specific servers based on Cisco Unified
Computing Server (UCS) technology or on a specification-based VM server. Cisco Meeting
Server is referred to as the Meeting Server throughout this document.
Note: Cisco Meeting Server software version 3.0 onwards does not support X-Series servers.
There are two layers to the Cisco Meeting Server: a platform and an application. The platform is
configured through the Mainboard Management Processor (MMP). The application runs on this
managed platform with configuration interfaces of its own.
The MMP is used for low level bootstrapping and configuration. It presents a command line
interface. On Cisco Meeting Server 2000, the MMP command line interface is accessed through
the Serial Over LAN connection. In virtualized deployments (the Cisco Meeting Server 1000, and
specification based VM servers) the MMP is accessed on virtual interface A.
Application level administration (call and media management) is undertaken via the API, or for
straightforward deployments, via the Web Admin Interface which can be configured to run on
any one of the available Ethernet interfaces.
Note: The Cisco Meeting Server software is referred to as the Meeting Server throughout the
remainder of this guide.
1.2.2 Virtualized deployments (Cisco Meeting Server 1000 and specification based
VM servers)
In virtualized deployments, the MMP is accessed through the VSphere console tab (on virtual
interface A) and requires the login credentials of an MMP admin user (see MMP User Account
Commands). These are set up as part of the installation procedure; see the Cisco Meeting
Server Installation Guide for Virtualized Deployments.
shutdown Not available through MMP. Use Do not use the vSphere power but-
Cisco UCS Manager to power ton. Use the shutdown com-
down blade servers before remov- mand instead.
ing power.
Connect your SFTP client to the IP address of the MMP which can be found using the ipv4
MMP or ipv6 MMP command (as appropriate). Log in using the credentials of an MMP admin
user (see MMP User Account Commands).
<> indicates a parameter that you must enter the appropriate value for
[ ] indicates an optional parameter
Some commands are followed by one or more examples in blue within the same table cell:
Command/Examples Description/Notes
n Left and right arrow keys move the cursor along the line of a typed command
n Up and down arrow keys cycle through the command history
n Quotation marks: to enter multiple word arguments use “” for example
pki csr demo CN:"callbridge.example.com" OU:"Cisco Support" O:Cisco L:"New
York" ST:NY C:US
callbridge ucm add <host- Adds a CUCM node to the Meeting Server. The command prompts the
name/IP> <axl_user> <pres- user to enter the password for the AXL user and presence user.
ence_user>
callbridge ucm del <host- Deletes the CUCM from the server.
name/IP>
callbridge ucm <hostname/IP> Validates the status of the AXL service. The command prompts the user
axl_service status to enter the password for the AXL user.
callbridge imps <hostname/IP> Validates the status of the presence service. The command prompts
<presence_user> presence_ser- the user to enter the password for the presence user.
vice status
callbridge ucm list Lists the details of the CUCM added to the Meeting Server along with
its hostname/IP, AXL user and presence user.
Enabling auto prioritization of audio and content share over video during web app meeting
Administrators can enable/ disable the auto prioritization of audio and content share over video:
Command/Examples Description/Notes
webbridge3 Enables or disables the auto prioritization feature in web app. If the command is not
audiopriflag configured, this feature is enabled by default.
(enable|disable)
Enable - If enabled, web app turns off the video and content share in low bandwidth
scenarios.
Disable - If disabled, web app does not take any action in an unstable network.
2 Network Commands
Command/Examples Description/Notes
iface <interface> mtu <value> Sets the maximum transmission unit size in bytes for an
iface a mtu 1400 interface.
2.2 IP Commands
Command/Examples Description/Notes
Command/Examples Description/Notes
ipv4 (a|b|c|d) add <server IP Configures the interface with an ipv4 address with specified
address>/<Prefix Length> prefix length and default gateway for egress packets. The
<Default Gateway> example configures A with address 10.1.2.3 on subnet
ipv4 a add 10.1.2.3/16 10.1.1.1 10.1.0.0/16. If there is no more specific route, packets
exiting via A will be sent via gateway 10.1.1.1.
ipv4 (a|b|c|d) del <server IP Removes the IPv4 address on the specified interface
address>
ipv4 (a|b|c|d) default Selects the interface of last resort for outbound
connections. When connecting to remote hosts it is not
always known from context which interface should be used.
By comparison, responses to connections initiated by remote
hosts will use the interface on which the connection was
accepted. This is sometimes referred to as the strong IP
model
ipv4 (a|b|c|d) route add Adds a static route so you can route a specific subnet out of
<address>/<prefix length> the specific interface. This is for unique routing scenarios
ipv4 (a|b|c|d) route del where multiple interfaces are enabled, and you want to
<address>/<prefix length> ensure that traffic for a specific subnet is routed out to the
gateway of that particular interface
Note: Generally manual configuration of a default route is not
required and may cause issues.
ipv4 b route add 192.168.100.0/24 All traffic destined for 192.168.100.x will go out of interface
b to interface b’s gateway
Command/Examples Description/Notes
Command/Examples Description/Notes
ipv6 (a|b|c|d) enable Starts auto-configuration of the specified interface for IPv6.
A link-local address is generated. Duplicate Address
Detection (DAD) is completed and, if SLAAC is enabled, then
Router Solicitations are sent. If a Router Advertisement is
received, then
l any advertised prefixes are used to construct global
addresses
l any RDDNS options are used to configure DNS
l if the "managed" or "other" flags are set, then DHCPv6
is started. If Router Advertisements do not have the
"managed" or "other" bits set, then DHCPv6 will not be
used
Command/Examples Description/Notes
ping <target Ping from the Meeting Server to the target IP address or hostname
address|hostname>
traceroute <target To traceroute from the Meeting Server to the target IP address or
address|hostname> hostname
Command/Examples Description/Notes
ping6 <target Ping from the Meeting Server to the target IPv6 address or hostname
address|hostname>
traceroute6 <target To traceroute from the Meeting Server to the target IPv6 address or
address|hostname> hostname
Note: Although packets can be captured by the Meeting Server, due to the high packet rate that
the Meeting Server operates at, packets may be dropped from the packet capture rather than
disturb the normal operation of the Meeting Server in handling calls. To avoid dropped packets
in the packet capture, Cisco recommends capturing packets at your network switch rather than
on the Meeting Server.
Command/Examples Description/Notes
pcap (a|b|c|d) Starts immediate packet capture on the specified interface and stops
when you press Ctrl-C. The name of the pcap file is then displayed.
This file can then be downloaded via SFTP.
The pcap command captures packets in multiple files, on rotation.
When a pcap file size exceeds 500MB, the packets are captured in a
new file. Meeting server saves upto four pcap files with a total
maximum file size limit of 2GB at any given time. Once the fourth pcap
file size exceeds 500MB, the oldest pcap file is deleted and continues
to capture packets in the new file.
Command/Examples Description/Notes
pcap (a|b|c|d|any) any will allow packet capture on multiple interfaces, i.e. any enabled
[snaplen <n>] [filter interfaces (interfaces that are not enabled will be skipped).
<pcap-filter-expression>] Note: When capturing from multiple interfaces, this requires additional
disk space as each interface is captured to a separate temporary file
and the files are then merged when the capture is stopped. So the
available storage when capture on multiple interfaces is half what is
available when capturing on a single interface.
filter selects only packets matching the criteria in the string. This
reduces the capture to only packets of interest, and avoids wasting
disk space on the others. The parsing of this string and the packet
filtering are performed with exactly the same underlying libraries as
used by tcpdump, so this has exactly the same expressive power and
performance. The filter expression can be up to around 4080
characters long, if required
Note: A service restart is required for changes to take effect: we recommend rebooting the
Core server.
Command/Examples Description/Notes
dscp (4|6) <traffic type> Sets the DSCP traffic . DSCP traffic categories and the traffic types
(<DSCP value>|none) within those categories are:
n signaling (SIP, AS-SIP signaling)
n assured-voice (any audio for AS-SIP)
n voice (any other audio)
n assured-multimedia (video for AS-SIP)
n multimedia (any other video)
n multimedia-streaming (webbridge media) (not currently used)
n low-latency (not currently used)
n oa&m (webadmin, LDAP, SSH, SFTP)
dscp assured (true|false) It is possible to configure both assured and non-assured DSCP
values for the "voice" and "multimedia" traffic types – see above.
Use this command to force the use of the assured or non-assured
value.
dscp assured true For example, to force the use of the assured-voice and assured-
multimedia DSCP values for all voice and video data, use this
command.
3 DNS Commands
Command/Examples Description/Notes
dns add trustanchor <anchor> Adds a trust anchor for Domain Name System Security
Extensions (DNSSEC).
dnsadd trustanchor ". IN DS 19036 8 2 Trust anchors should be specified in DNS Resource Record
49AAC11D7B6F6446702E54A1607371607A1A4 form inside quotation marks – see the example. See [1] for
1855200FD2CE1CDDE32F24E8FB5" details.
Command/Examples Description/Notes
dns add rr <DNS RR> To configure the DNS resolver(s) to return values which are
dns add rr "sipserver.local. IN A not configured in external DNS servers or which need to be
172.16.48.1" overridden, custom Resource Records (RRs) can be
dns add rr "_sip._tcp.example.com. configured which will be returned instead of querying
86400 IN SRV 0 5 5060 external DNS servers.
sipserver.local."
We accept RRs in quotation marks with the following
format:
OWNER <OPTIONAL TTL> CLASS TYPE TYPE-
SPECIFIC-DATA
For example,
A records sipserver.local. IN A 172.16.48.1
dns lookup <a|aaaa|srv> The lookup "drills" through SRV results. That is, when an
<hostname> SRV record returns a domain name this is resolved by A and
dns lookup srv _sip._tcp.example.com AAAA lookups.
dns flush This flushes the DNS cache of of the Meeting Server.
4 Firewall Commands
The MMP supports the creation of simple firewall rules for the media interfaces. After setting up
the firewall rule on an interface, enable the firewall on that interface.
Note: This is not intended to be a substitute for a full standalone firewall solution.
Tag Rule
--- ----
0 drop 80
CAUTION: We recommend using the serial console, if available, to configure the firewall,
because using SSH means that an error in the rules would make the SSH port inaccessible.
Command/Examples Description/Notes
firewall a Displays the status and rule set for the interface a
Command/Examples Description/Notes
firewall a deny 678 Drops all packets on port 678 on media interface A
firewall a allow ssh from 192.168.1.0/28 Allows SSH access to interface a from the 256 IPv4
address between 192.168.1.0 and 192.168.1.255
firewall <iface> delete <tag> To delete a rule, use its tag with this command.
5 LDAP Commands
The new ldap option is added to user add MMP command enables configuring details of an
LDAP server, directory search parameters, TLS settings, and enabling or disabling LDAP
authentication.
To enable adding LDAP users, a new option, [ldap] is added to the command:
user add <username> (admin|crypto|audit|appadmin|api) [ldap]
Note: Meeting Server API does not support access to users with LDAP authentication.
ldap
ldap server <hostname|address> <port>
ldap protocol (ldap|ldaps)
ldap binddn <username>
ldap basedn <base DN>
ldap login_attr <attribute>
ldap filter <filter>
ldap remove <binddn|filter|trust>
ldap trust <crt bundle>
ldap verify (enable|disable)
ldap min-tls-version <minimum version string>
ldap enable
ldap disable
ldap status
Note:
The user list MMP command is extended to include logged in LDAP users.
The only user rule parameters that apply to LDAP users are max_failed_logins, max_idle,
and max_sessions. Other parameters of this command do not apply to LDAP users.
The user expire MMP command is not supported for LDAP users.
ldap server <hostname|address> <port> Specifies the LDAP server with hostname or IP
address, and port number. This is mandatory.
ldap binddn <username> Adds the distinguished name with which to bind
ldap binddn to the directory server for lookups.The binddn
cn=binduser,oi=user,dc=domain,dc=com parameter is optional. If not specified, anonymous
bind requests are used.
ldap binddn "cn=bind user,o=My
Company,dc=domain,dc=com" The bind user must have search permission in the
directory. This command prompts for an optional
ldap binddn domain\\username
bind password.
If spaces are included in the argument, then the
argument has to be quoted. If backslashes are
included, they must be escaped with a preceding
backslash.
ldap basedn <base DN> Specifies the base distinguished name to use as
search base. It is mandatory to specify basedn.
If spaces are included in the argument, then the
argument has to be quoted. If backslashes are
included, they must be escaped with a preceding
backslash.
ldap login_attr <attribute> Specifies the LDAP attribute name such as uid,
userPrincipalName, or sAMAccountName, which
uniquely identifies users. The attribute value must
match the pre-configured MMP user name for
successful login. Specifying an attribute is
mandatory.
ldap trust <crt bundle> Configures the system to use a particular bundle
of certificates to validate the certificate.
To use a secure connection to the LDAP server,
this must be configured with a trusted CA.
ldap min-tls-version <minimum version string> Configures the minimum TLS version that the
system will use. Possible values are 1.0, 1.1, and
1.2. The default is version 1.2.
6 Scheduler Commands
Scheduling meetings is enabled by the new Scheduler component, which can be configured by
the new scheduler MMP commands.
The configuration details of the email server are provided via the new scheduler MMP
commands listed below:
scheduler https listen <interface> Configures an interface:port pair for the Scheduler to listen
<port> on.
scheduler https listen none Disables the Scheduler's management API interface.
scheduler https certs <key-file> <crt- Configures the server certs used in the management API but
fullchain-file> also the certs used when making outbound connections.For
example, the c2w link or any API calls to the Call Bridge.
scheduler https certs none Removes certificate configuration for the management API.
scheduler c2w certs <key-file> <crt- Configures the certificate bundle presented to a Web Bridge
fullchain-file> 3.
scheduler c2w certs none Removes certificate configuration for the TLS connection to
Web Bridge 3.
scheduler c2w trust <crt-bundle> Configures the trust bundle for verifying connections to the
Web Bridges.
scheduler c2w trust none Removes the certificate bundle for the Web Bridge 3 from
the Scheduler's trust store.
scheduler email server <hostname | Configures the SMTP server to which the Scheduler will
address> <port> send emails.
scheduler email server none Removes email server configuration from the Scheduler.
scheduler email username <smtp user- Configures the email account used for authentication with
name> the SMTP server. This account must have appropriate
permissions to be able to send emails on behalf of the
meeting organizers.
scheduler email remove username Removes the email username configured for SMTP authen-
tication.
scheduler email protocol <smtp | Specifies the Scheduler's communication with the email
smtps> server as:
smtp: over plain text TCP (smtp)
smtps: over an encrypted TLS channel
scheduler email starttls (enable | dis- Enables or disables opportunistic TLS for SMTP con-
able) nections.
scheduler email trust <bundle> | none (Optional) Allows configuration of a trust bundle for the
email server. If configured, verification is done for the
certificate of the email server using the configured bundle.
If not configured, verification of the certificate is not done.
scheduler email common-address Configures the common email address and a display name
<[email protected]> "<Display on the Meeting Server. The Scheduler sends the meeting
name>" invites from the common email address to the participants.
If left blank, the Scheduler sends the email invites from the
organizer’s email address.
scheduler email common-address Removes the common email address and display name that
none has been configured.
scheduler timedLogging (webBridge|ap- Activates logging for the specified time period.
i|email) <time>
Command/Examples Description/Notes
pki list Lists PKI files i.e. private keys, certificates and cer-
tificate signing requests (CSRs).
pki inspect <filename> Inspect a file and shows whether the file is a private
key, a certificate, a CSR or unknown. In the case of
certificates, various details are displayed. If the file
contains a bundle of certificates, information about
each element of the bundle is displayed.
Both PEM and DER format files are handled.
pki match <key> <certificate> This command checks whether the specified key and a
certificate on the system match. A private key and a cer-
tificate are two halves of one usable identity and must
match if they are to be used for a service e.g. HTTPS.
pki unlock <key> Private keys are often provided with password-
protection. To be used in the Meeting Server, the key
must be unlocked.
This command prompts for a password to unlock the
target file. The locked name will be replaced by an
unlocked key with the same name
Command/Examples Description/Notes
pki csr <key/cert basename> For users happy to trust that Cisco meets requirements
[<attribute>:<value>] for generation of private key material, private keys and
associated Certificate Signing Requests can be
pki csr dbserver generated.
CN:server01.db.example.com <key/cert basename> is a string identifying the new key
subjectAltName:server02.db.example.com and CSR (e.g. "new" results in "new.key" and
"new.csr" files)
Attributes for the CSR can be specified in pairs with the
attribute name and value separated by a colon (":").
Attributes are:
CN: commonName which should be on the certificate.
The commonName should be the DNS name for the
system.
OU: Organizational Unit
O: Organization
L: Locality
ST:State
C: Country
emailAddress: email address
Command/Examples Description/Notes
pki selfsigned <key/cert basename> You can use this command to generate self-signed
[<attribute>:<value>] certificates.
<key/cert basename> identifies the key and certificate
pki selfsigned dbca CN:"my company CA"
which will be generated, e.g. "pki selfsigned new"
OU:"My company" O:cms L:Raleigh ST:"North
Carolina" C:US creates new.key and new.crt (which is self-signed).
Attributes for the certificate can be specified in pairs
with the attribute name and value separated by a colon
(":"). Attributes are:
CN: commonName. If the certificate is used as end-
entity certificate, the commonName should be the DNS
name for the relevant service..
OU: Organizational Unit
O: Organization
L: Locality
ST:State
C: Country
emailAddress: email address
Self-signed certificates can be used to sign CSRs.
They are useful to deploy on internal services such as
the database cluster. For external services such as Web
services, use an external CA.
pki sign <csr/cert basename> <CA This command signs the csr identified by <csr/cert
key/cert basename> basename> and generates a certificate with the same
basename, signed with the CA certificate and key
pki sign dbserver dbca
identified by <CA key/cert basename>.
pki sign dbclient dbca
The files <csr/cert basename> and <CA key/cert
basename> should have been generated by the
commands 'pki csr' and 'pki selfsigned' respectively.
pki pkcs12-to-ssh <username> Public SSH keys stored in PKCS#12 files can be used
but need to be processed first. This command extracts
a useable public key from a PKCS#12 file uploaded with
the name <username>.pub.You are prompted to enter
the password for the pkcs#12 file. After completion, the
pkcs#12 file is replaced with a useable key without
password protection.
Note: Any other data contained in the pkcs#12 file is
lost.
pki pkcs12-to-ssh john The key of an uploaded PKCS#12 file john.pub for user
john can be made useable by executing this command
Command/Examples Description/Notes
Command/Examples Description/Notes
pki list Lists PKI files i.e. private keys, certificates and certificate signing
requests (CSRs).
pki inspect <filename> Inspect a file and shows whether the file is a private key, a
certificate, a CSR or unknown. In the case of certificates, various
details are displayed. If the file contains a bundle of certificates,
information about each element of the bundle is displayed.
Both PEM and DER format files are handled.
pki match <key> <cer- This command checks whether the specified key and a certificate
tificate> on the system match. A private key and a certificate are two halves
of one usable identity and must match if they are to be used for a
service e.g. callbridge.
pki unlock <key> Private keys are often provided with password-protection. To be
used in the Meeting Server, the key must be unlocked.
This command prompts for a password to unlock the target file. The
locked name will be replaced by an unlocked key with the same
name
Command/Examples Description/Notes
pki csr <key/cert basename> For users happy to trust that Cisco meets requirements for
[<attribute>:<value>] generation of private key material, private keys and associated
Certificate Signing Requests can be generated.
pki csr example <key/cert basename> is a string identifying the new key and CSR
CN:www.example.com OU:"My Desk" (e.g. "new" results in "new.key" and "new.csr" files)
O:"My Office" L:"San Jose" Attributes for the CSR can be specified in pairs with the attribute
ST:California C:US name and value separated by a colon (":"). Attributes are:
CN: commonName which should be on the certificate. The
commonName should be the DNS name for the system.
OU: Organizational Unit
O: Organization
L: Locality
ST:State
C: Country
emailAddress: email address
Command/Examples Description/Notes
pki selfsigned <key/cert You can use this command to generate self-signed certificates.
basename> <key/cert basename> identifies the key and certificate which will
[<attribute>:<value>] be generated, e.g. "pki selfsigned new" creates new.key and
new.crt (which is self-signed).
Attributes for the CSR can be specified in pairs with the attribute
name and value separated by a colon (":"). Attributes are:
CN: commonName which should be on the certificate. The
commonName should be the DNS name for the system.
OU: Organizational Unit
O: Organization
L: Locality
ST:State
C: Country
emailAddress: email address
The CSR file can be downloaded by SFTP and given to a certificate
authority (CA) to be signed. On return it must be uploaded via
SFTP. It can then be used as a certificate.
Keep the size of certificates and the number of certificates in the
chain to a minimum; otherwise TLS handshake round trip times will
become long.
pki sign <csr/cert basename> This command signs the csr identified by <csr/cert basename> and
<CA key/cert basename> generates a certificate with the same basename, signed with the
CA certificate and key identified by <CA key/cert basename>.
The files <csr/cert basename> and <CA key/cert basename>
should have been generated by the commands 'pki csr' and 'pki
selfsigned' respectively.
pki pkcs12-to-ssh <username> Public SSH keys stored in PKCS#12 files can be used but need to
be processed first. This command extracts a useable public key
from a PKCS#12 file uploaded with the name <username>.pub.You
are prompted to enter the password for the pkcs#12 file. After
completion, the pkcs#12 file is replaced with a useable key without
password protection.
Note: Any other data contained in the pkcs#12 file is lost.
pki pkcs12-to-ssh john The key of an uploaded PKCS#12 file john.pub for user john can be
made useable by executing this command
Note: If TLS certificate verification is enabled, ensure that the remote device’s certificate has
both Server and Client Authentication attributes defined. This will ensure both outgoing and
incoming TLS connections are accepted.
Note: When LDAP servers are configured with secure connection, connections are not fully
secure until TLS certificate verification has been configured using the tls ldap command on
the MMP.
Meeting Server uses a minimum of TLS 1.2 and DTLS 1.2 by default for all services: SIP, LDAP,
SYSLOG, HTTPS (inbound connections: API, Web Admin and Web Bridge 3; outbound
connections: CDRs) and RTMPS. If needed for interop with older software that has not
implemented TLS 1.2, a lower version of the protocol can be set as the minimum TLS version
for the SIP, LDAP and HTTPS services. See tls <service> min-tls-version <minimum
version string> and tls min-dtls-version <minimum version string> commands
below.
Note: A Call Bridge restart is required for changes to the tls configuration to be applied.
However if the tls syslog configuration is modified, then the syslog service must be disabled
and enabled after the call bridge restart.
Note: A future version of Meeting Server may completely remove TLS 1.0.
Com-
mand/Examples Description/Notes
tls <service> Configures the system to use a particular bundle of certificates to validate the certificate
trust <crt of a remote service
bundle>
tls ldap trust
ldap.crt
tls <service> Enables/disables certificate verification for a service. When enabled, if the system fails to
verify verify the remote service's certificate, then the connection will be aborted.
(enable|dis- Enables verification with the additional requirement that the remote service returns a
able|ocsp) stapled OCSP response to ascertain certificate revocation status.
The connection to the remote service will be aborted if either the system fails to verify
the certificate validity or the certificate revocation status is unknown or revoked.
Com-
mand/Examples Description/Notes
tls sip ciphe See below for an explanation of when you might need to use the tls cipher command.
rs <cipher The cipher string format is a colon separated list of ciphers as used by OpenSSL
string> (https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-
FORMAT). The current default for cipher support is:
"ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:RS
A+AESGCM:RSA+AES:!aNULL:!MD5:!DSS:!3DES" (up to Version 2.4.2)
"ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:RS
A+AESGCM:RSA+AES:!aNULL:!MD5:!DSS:!3DES:!aDH:!aECDH" (from version 2.4.3
onwards)
ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:RS
A+AESGCM:RSA+AES:!aNULL:!MD5:!DSS:!3DES:!aDH:!aECDH
tls <service> Use this command to change the default TLS version used by the Meeting Server. (From
min-tls- version 2.3). Note: When you change the minimum version of TLS, you need to restart
version the Call bridge service using the command callbridge restart.
<minimum The Meeting Server uses a minimum of TLS 1.2 for all services. If needed for interop with
version older software that has not implemented TLS 1.2, the minimum TLS version for SIP, LDAP
string> and HTTPS can be configured to a lower version of the protocol.
tls sip min- Use TLS version 1.1 or later for SIP
tls-version 1.1
tls ldap min- Use TLS version 1.1 or later for LDAP
tls-version 1.1
tls min-dtls- Configures the minimum DTLS version that the system will use. (From version 2.3). Note:
version When you change the minimum version of DTLS, you need to restart the Call bridge
<minimum service using the command callbridge restart. (From version 2.3)
version
string> If needed for interop with older software that has not implemented DTLS 1.2, configure
tls min-dtls-
DTLS to use a lower version of the protocol.
version 1.1
By default, the Meeting Server only uses secure ciphers for any TLS connections, including SIP
TLS on tcp port 5061. However, this may mean that the Meeting Server may be unable to make
TLS calls with older, less secure devices. If your deployment has older kit, use this tls ciphers
command to specify a list of ciphers that is acceptable to the older devices. See the Openssl
guide for more information on ciphers.
Symptoms that a device cannot handle secure ciphers include:
n SIP TLS calls failing to the device,
n HTTPS access not working on the device,
Command/Examples Description/Notes
uptime Displays the time since the Meeting Server was last
rebooted
timezone <timezone name> Sets the time zone for the Meeting Server. The Meeting
timezone Europe/London Server uses the standard IANA time zone database. See
this link for a list.
Note: A reboot is required after issuing this command.
ntp groupkey <keyfile> Adds an NTPv4 group key for autokey support
ntp groupkey group.key For example, a group key file can be uploaded using
ntp autokey enable SFTP to "group.key" and configured with these
commands.
date Displays the current system (in UTC) and local time
Command/Examples Description/Notes
date set <date> <time> Sets the date and time. This command should only be
necessary in virtualized deployments, and server
deployments that do not use an NTP server.
The accepted formats for date and time are:
l ISO 8601 format (%Y-%m-%d) plus 24-hour
time with hour separated by a space
l %m/%d/%y plus 24 hour time
callbridge listen (interface allowed Configures one or more interfaces (chosen from A, B, C
list|none) or D) for the Call Bridge to listen on.
callbridge listen a
callbridge listen none Stops the Call Bridge and disables listening services;
however, the Call Bridge remains enabled.
callbridge prefer <interface> Choses one interface from the interface allowed list as
the "preferred" SIP interface: this interface is used as
the contact address when routing or heuristics cannot
be used to select a unique interface.
callbridge certs <key-file> <cert- Defines the names of the key file name and certificate
file>[<crt-bundle>] file name for the Meeting Server and, optionally, a CA
certificate bundle as provided by your CA. (Also see
Chapter 7.)
callbridge trust cluster <trusted Configures the Call Bridge to use a particular bundle of
cluster certificate bundle> certificates to validate the identity of the Call Bridges in
the cluster. The bundle can be either a certificate chain,
or an allowed list of trusted certificates. (From version
2.4).
Command/Examples Description/Notes
callbridge trust cluster none Removes the certificate bundle for the Call Bridge
cluster from the Call Bridge trust store. (From version
2.4).
callbridge trust branding <trusted Configures the Call Bridge to use the specified
branding server certificate whitel- certificate to validate against the branding server
ist> certificate. (From 3.5)
Note: If branding server hosted over HTTPS, the
Meeting Server and branding server certificates must be
signed by valid or same CA. Meeting Server may fail to
communicate with the branding server if the branding
server certificates are not signed by valid CA.
callbridge restart Restarts the core media services. Note: Rebooting the
Meeting Server will disconnect any calls. The process
takes some minutes to complete.
syslog server add <hostname> The Meeting Server can send its log files to a remote
[<port>] syslog server over TCP (not UDP)
syslog server del <hostname> The port defaults to 514
syslog server add tls:syslog.example.com To specify that TLS should be used to protect the
514 syslog data in transit, prefix the hostname/IP address of
the remote server with "tls:"
syslog tail [<number of lines>] Shows the most recent log messages. By default this is
10 messages but the number can be changed with the
optional argument
syslog page Displays the complete log interactively. Press the Space-
bar to display the next page of log messages; press q to
quit.
Command/Examples Description/Notes
syslog search <string> Displays only those messages that match a certain
syslog search error pattern
Note: If the current user has the audit role then the tail
and search commands display audit log messages;
otherwise they display message from the system log.
See Section 12.6 for details on downloading the system
logs
syslog rotate <filename> Saves the log file permanently to the file with the
syslog rotate mylog specified filename, and empties the active system log.
The saved file can be downloaded using SFTP.
Command/Examples Description/Notes
Note: Do not confuse user accounts set up with the commands in this section, with accounts
which are set up using Active Directory and which let users log in on a Cisco Meeting App and
make calls.
Unless otherwise mentioned the following commands require you to be logged into an MMP
account with admin rights.
Command/Examples Description/Notes
user add <username> Creates a new MMP user of the specified type (see above)
(admin|crypto|audit|appadmin|api) or the user created is a LDAP user.
[ldap] Prompts for a password for the user which must be entered
twice to ensure that the intended password is configured.
On first login, the user will be asked to configure a new
password.
user list Displays the list of users, their role, the expiry date of their
password and whether or not they are logged in.
Command/Examples Description/Notes
user info <username> Displays user details including role, last login, number of
failed login attempts since last login, last time password
was changed, expiry date of password, if the account is
locked or not.
user evict <username> Logs a user out from their MMP session. Note: if you use
this command on a user who is currently active in a Web
Admin session, your MMP session will freeze and you will
need to relogin to the MMP.
user unlock <username> Removes a lock on logins for a user caused by exceeding
the maximum failed logins
user expire <username> Forces a user to configure a new password on next login.
Note: this command does not apply to user type "api",
their passwords do expire over time, but they cannot be
forced to change their password via this command.
user host <username> add|del Restricts remote access for a user from hosts in an allowed
<hostname> list given as domain names or IP addresses.
Note: The user info command displays the current list
of allowed hosts (if any) – see above
user host bob add 192.168.1.3 Adds 192.168.1.3 to the list of acceptable source
addresses for remote hosts when bob tries to log in
Command/Examples Description/Notes
user duty <username> <duty hours> Restricts the duty hours of a user
user duty <username> none The duty hours parameter is used to indicate the times at
which a user can access the system. The format is a list of
day/time-range entries. Days are a sequence of two-
character representations: Mo, Tu, We, Th, Fr, Sa, Su. All
weekdays (days excluding Saturday and Sunday) are
represented by Wk, the weekend days by Wd and all days
in the week by Al. Note that repeated days are unset MoMo
= no day, and MoWk = all weekdays except Monday.
A day/time-range prefixed with a '!' indicates "anything
but" e.g. !MoTu means anything but Monday and Tuesday.
The time-range is two 24-hour times HHMM, separated by
a hyphen '-', to indicate the start and finish time. A finish
time is earlier than the start time indicates that the duty
continues into the next day.
Multiple rules can be combined with the '|' symbol to mean
'or' e.g. MoTu1200-1400|We1400-1500 means Monday or
Tuesday between 1200 and 1400 or Wednesday between
1400-1500.
user duty bob Wk0900-1700|Sa1200-1300 Allows bob access during office hours (9 to 5) on
weekdays and between 1200 and 1300 on a Saturday
CAUTION: Do not reuse your admin credentials for any other configuration. For example, your
TURN server username and password must be unique.
Command/Examples Description/Notes
user rule max_history Prevents password reuse by checking new passwords against that
<number> user’s previous number of passwords
user rule min_password_age Prevents the password history controls being circumvented, by
<number> setting a minimum interval before a password can be reset.
Note: This interval is overridden when an admin enters the "user
expire <username>" command.
user rule min_special Sets the minimum number of "special" characters: !@#$%^&*()_
<number> +=?><,."\/
user rule longest_digits_run Sets the maximum consecutive digits allowed in a password
<number>
user rule min_changed_ Sets the minimum number of character positions in the new
characters <number> password which must differ from the old
user rule no_username Prevents a password being set that contains the user name.
<true|false>
Command/Examples Description/Notes
user rule max_failed_logins Sets the number of failed logins allowed, before a 15 minute
<attempts> lockout for MMP users or Cisco Meeting App users that
authenticate via LDAP. Guest access to meetings held on the
Meeting Server are unaffected. If set to 0, this rule will lock out
users with valid credentials.
Note that the Call Bridge needs to be restarted for user rule max_
failed_logins <attempts> to take effect. Changes are immediately
applied to MMP users.
user rule max_idle <number> Sets the maximum number of days that an account can be idle
before it is locked. The minimum value is 1.
user rule max_sessions Limits any user to <number> of simultaneous SSH or SFTP or Web
<number> Admin sessions.
For example, if the maximum number of sessions is configured as 5
then you can have 5 SSH, or 5 web admin, or 5 SFTP sessions
simultaneously.
Command/Examples Description/Notes
cac issuer <issuer cert- To validate CAC users, an issuer certificate bundle needs to be
bundle> uploaded to the MMP using SFTP. Legitimate credentials will have
been cryptographically signed by one of the issuer certificates; if
not, then the login will fail. Contact your site cryptography officer
for more information
cac ocsp enable|disable Online Certificate Status Protocol (OCSP) is a mechanism for
checking the validity and revocation status of certificates. The
MMP can use this to work out whether the CAC used for a login is
valid and, in particular, has not been revoked.
If the MMP is configured to be in "strict" CAC mode (no password
logins allowed – see above), then access to the MMP can be
restricted centrally by revoking certificates.
OCSP can be enabled without special configuration. In this mode,
the URL of the OCSP responder will be read from the CAC
credentials presented to the MMP if present. If an OCSP responder
is not present, or the OCSP responder is not available (is down,
can't be routed to, etc.), then CAC logins fail.
cac ocsp responder To configure a URL for an OCSP responder, use this command.
<URL|none> This URL will override any provided by the CAC.
cac ocsp certs <key-file> Some OCSP responders require OCSP requests to be signed by
<crt-file> the requestor. This command specifies a private key and (matching)
public certificate for this operation:
It is likely that the OCSP responder will require that the signing
certificate is signed by a particular authority, perhaps the issuer of
the CAC certificates. This is a site-local consideration.
Internet Explorer:
IE can export the CAC (public) credentials as X509 encoded as DER, which can be uploaded
and used without further steps (cf. pkcs#12)
callbridge ucm add <host- Adds a CUCM node to the Meeting Server. The command prompts the
name/IP> <axl_user> <pres- user to enter the password for the AXL user and presence user.
ence_user>
callbridge ucm del <host- Deletes the CUCM from the server.
name/IP>
callbridge ucm <hostname/IP> Validates the status of the AXL service. The command prompts the user
axl_service status to enter the password for the AXL user.
callbridge imps <hostname/IP> Validates the status of the presence service. The command prompts
<presence_user> presence_ser- the user to enter the password for the presence user.
vice status
callbridge ucm list Lists the details of the CUCM added to the Meeting Server along with
its hostname/IP, AXL user and presence user.
Note: "Call Bridge to Web Bridge" protocol (C2W) is the link between the callbridge and
webbridge3.
The MMP commands to deploy Web Bridge 3 to use Cisco Meeting Server web app — the new
browser-based client for Cisco Meeting Server that lets users join meetings (audio and video) —
are listed in the table below.
Command Description
webbridge3 https listen <interface:port Sets up the interface(s) and port(s) for the Web
allowed list> Bridge 3 to listen on. Enable the service to start
listening with the command webbridge3
enable. There is no default value for the port; it
needs to be specified.
webbridge3 https certs <key-file> <crt- Sets the HTTPS certificates for the Web Bridge 3.
fullchain-file> These are the certificates that will be presented to
web browsers so they need to be signed by a
certification authority (CA) and the
hostname/purpose etc needs to match. (The
certificate file is the full chain of certificates that
starts with the end entity certificate and finishes
with the root certificate.)
Command Description
webbridge3 c2w listen <interface:port Configures the C2W connection. Sets up the
allowed list> interface(s) and port(s) for the Web Bridge 3 to
listen on. You must enable the service to start
listening with the command webbridge3
enable. We recommend that you make this
address/port accessible from the Call Bridge(s)
only.
webbridge3 c2w certs <key-file> <crt- Configures the C2W connection certificates — you
fullchain-file> need to configure the SSL Server certificates used
for the C2W connection. The C2W certificate is
only presented to Call Bridges connecting to the
C2W protocol connection port — the
hostname/purpose etc needs to match. (The
certificate file is the full chain of certificates that
starts with the end entity certificate and finishes
with the root certificate.)
webbridge3 c2w trust <crt-bundle> Sets the trust bundle that Web Bridge 3 C2W server
will verify the Call Bridge client certificate against
to determine whether to trust them or not.
webbridge3 c2w trust none Removes C2W connection trust bundle con-
figuration.
Command Description
webbridge3 options none Switches off all features that were previously
switched on using the webbridge options <feature_
name> command. Only use under instruction from
Cisco Support. (This command is currently not sup-
ported.)
Note: The TURN Server component is not available on the Cisco Meeting Server 2000.
Note: The TURN server component always supports the standard port 3478 for UDP.
When deploying Cisco Meeting Server web edge, the API node /turnServers "type"
parameter should be set to "cms". If this parameter is unset, it defaults to "standard", and tells
the clients to use TCP/UDP port 443 to connect to the TURN server. For more information on
the "type" parameter values, see the section Setting up and modifying TURN servers in Cisco
Meeting Server API Reference Guide.
Setting up a TURN server is described in the Deployment Guides. This section provides a
command reference.
Command/Examples Description/Notes
turn listen <interface allowed Sets up an allowed list of interfaces to listen on. To
list|none> start listening, you must enable the service with the
turn listen a b command turn enable.
turn tls <port|none> Sets an additional port to be used for TURN, and
enables TCP usage for TURN.
Note: Set TURN to listen for TCP traffic as well as
UDP, on the port specified as well as port 3478, for all
three services. This option MUST be set for TURN to
listen on any service beside UDP, and for TURN to
listen on any port beside 3478.
turn certs <keyfile> <certificate Defines the name of the private key file and .crt file for
file> [<cert-bundle>] the Turn Server application and, optionally, a CA
certificate bundle as provided by your CA. (Also see
the section Provisioning with Certificates.)
This option is required if 'turn tls <port>' is in use.
turn credentials <username> Sets the long term credentials for the TURN server.
<password> <realm>
turn credentials myusername mypassword
example.com
turn public-ip <public ip> Sets up a public IP address for the TURN server.
turn short_term_credentials_mode Toggles the TURN server between short- and long-
(enable|disable) term credential mode. Default is disable. (from ver-
sion 3.1)
Command/Examples Description/Notes
turn short_term_credentials <shared Specifies the shared secret and realm required by the
secret> <realm> TURN server to use short-term credentials. (from ver-
sion 3.1)
turn short_term_credentials mysharedsecret
example.com
Note: Port 8081 is reserved on loopback if the webadmin is enabled, but is not reserved if the
webadmin is disabled. Port 8080 is always open.
Command/Examples Description/Notes
webadmin listen (a|b|c|d) [<port>] Sets up the interface for the Web Admin Interface to listen
webadmin listen a on. To start listening, you must enable the service with the
webadmin listen a 443 command webadmin enable.
The default is port 443.
webadmin certs <keyfile-name> <crt Provides the name of the key file and .crt file for the Web
filename> [<crt-bundle>] Admin Interface and, optionally, a CA certificate bundle as
provided by your CA
Note: MMP user accounts are also used to log in to the Web Admin Interface.
From version 2.7, database clusters require client and server certificates signed by the same CA
configured in each Meeting Server holding or connecting to a database in the cluster. Enforcing
the use of certificates ensures both confidentiality and authentication across the cluster.
CAUTION: If a database cluster was configured without certificates using an earlier version of
Meeting Server software which did not require certificates, then on upgrading to version 2.7 the
database will stop and remain unreachable until certificates are configured and the database
cluster is recreated.
Note: <ca_crt> is the database cluster CA certificate bundle. This is also used as a trust store, so
database connections that give a valid certificate name and a certificate chain that ends with a
root certificate present in the bundle will be accepted.
Command/Examples Description/Notes
database cluster status Displays the clustering status, from the perspective of
this database instance.
Note: From 2.7 this command will highlight the lack of
configured certificates.
database cluster localnode This command must be run on the server that will host
<interface> the initial primary database before initialising a new
database cluster.
The <interface> can be in the following formats:
[a|b|c|d] - the name of the interface (the first IPv6
address is preferred, otherwise the first IPv4 address is
chosen) e.g. database cluster localnode a
ipv4:[a|b|c|d] - the name of the interface, restricted to
IPv4 (the first IPv4 address is chosen) e.g. database
cluster localnode ipv4:a
ipv6:[a|b|c|d] - the name of the interface restricted to
IPv6 (the first IPv6 address is chosen) e.g. database
cluster localnode ipv6:a
<ipaddress> - a specific IP address, can be IPv4 or
IPv6 e.g. database cluster localnode 10.1.3.9
database cluster initialize Creates a new database cluster, with this server’s
current database contents as the one and only
database instance—the primary.
The command reconfigures postgres to cluster mode
- i.e. listens on external interface and uses SSL
Reconfigures and restarts the local Call Bridge (if it is
enabled) to use the database cluster.
Note: From 2.7 this command will not run without valid
certificates, keys and CA certificates uploaded to the
database clients and servers.
Command/Examples Description/Notes
database cluster join <hostname/IP Creates a new database instance as part of the cluster
address> copying the contents of the primary database to this
server and destroying the current contents of any
database on it.
<hostname/ip address> can be for any existing
database in the cluster.
Reconfigures and restarts the local Call Bridge (if it
exists and it is enabled) to use the database cluster
Note: From 2.7 this command will not run without valid
certificates, keys and CA certificates uploaded to the
database clients and servers.
database cluster certs <server_key> Configures the certificates used to secure the
<server_crt> <client_key> <client_ connections in a database cluster.
crt> <ca_crt> Certificates must be configured before the database
database cluster certs dbcluster_ cluster can be enabled.
server.key dbcluster_server.crt dbcluster_
client.key
dbcluster_client.crt dbcluster_ca.crt
database cluster certs <client_key> Configures the certificates used to secure the
<client_crt> <ca_crt> connections in a database cluster where there is no
database cluster certs dbcluster_ co-located database on the Call Bridge.
client.key dbcluster_client.crt dbcluster_
ca.crt
Command/Examples Description/Notes
database cluster remove Removes one database from the cluster if run on a
database host server, “un-connects” a Call Bridge if
run on a host server with only a Call Bridge, or both if
the server hosts both a clustered database and a Call
Bridge.
database cluster upgrade_schema Upgrades the database schema version in the cluster
to the version this node expects. We recommend that
you run this command:
l on the primary database, but it can be run on any
database instance
l after every software upgrade on any server hosting
a database instance or Call Bridge
Note: The Uploader is not available on the Cisco Meeting Server 2000.
Uploader simplifies using Vbrick Rev for video content management. This section provides a
command reference for the Uploader.
Commands Description
uploader nfs <host- Specify the NFS that the Uploader will monitor.
name/IP>:<directory>
Commands Description
uploader (cms|rev) host <host- Configure the Uploader with the name of the host for the Meet-
name> ing Server (cms) and the host for the Vbrick Rev server. Default
port is 443.
uploader (cms|rev) port <port> Configure the Uploader with the port to use to connect to the
Meeting Server (cms) and the port for the Vbrick Rev server.
Default port is 443.
uploader (cms|rev) user <user- Configure the Uploader with the user that has access to the API
name> of the Meeting Server and the user with access to the Vbrick
Rev server.
uploader (cms|rev) password Configure the Uploader with the password for the specified Meet-
ing Server user and the Vbrick Rev user.
uploader (cms|rev) trust Upload the specified certificate bundle to the trust store on the
(<crt-bundle>|none) Meeting Server or the Vbrick Rev server. none removes the cer-
tificate bundle from the specified trust store. Note: the Uploader
will not work without a certificate bundle in the Meeting Server
trust store and the Vbrick Rev trust store.
uploader cospace_member_access Allows members of the space to view or edit the video record-
<view|edit|none> ings. none removes view or edit permissions for members of the
space.
uploader recording_owned_by_ true selects the owner of the space as the single owner of
cospace_owner <true|false> these video recordings.
uploader fallback_owner (<user- Use the named user as the fallback owner of the video record-
name>|none) ings, if the owner of the space is not listed in VbrickRev. none
removes the fallback owner.
uploader ratings (enable|dis- Enables or disables video recording ratings. Default is disabled.
able)
uploader downloads (enable|dis- Sets the download permission, enables or disables downloading
able) the video recordings.
uploader initial_state (<act- Set the initial state of the video recording when first uploaded to
ive|inactive>) Vbrick Rev. Default is active.
Commands Description
uploader delete_after_upload Selects whether to delete the video recording from the NFS
(<true|false>) after upload is complete. Default is false.
Note: The uploader debug (<true|false>) command was removed in version 2.4,
debugging information is automatically sent to the syslog server.
Note: The Recorder is not available on the Cisco Meeting Server 2000.
This section provides a command reference for the Recorder. Follow the instructions in the
appropriate deployment guide to deploy the recorder.
Command/Examples Description/Notes
recorder sip certs Allows you to configure a SIP certificate. (Added from ver-
sion 3.0.)
recorder sip listen <interface> The SIP recorder/streamer components do not need to
<tcp-port|none> <tls-port|none> listen for https connections, however, they do need to
listen for SIP connections. This new MMP command is
introduced for setting both TCP and TLS. (Added from
version 3.0.)
recorder sip trace Turns on logging of all SIP messages. All SIP messages
<1m|10m|30m|24h|on|off> will be logged on the recorder. Default is "off". You can
enable it permanently with "on" or for a fixed time period.
(Added from version 3.0.)
recorder limit <value|none> Sets the recorder limit to allow scalability. This is the limit
above which calls are rejected so that call control can fail
over to another device. (Added from version 3.0).
recorder nfs Provides the Recorder with details of the network file
<hostname/IP>:<directory> server (nfs) and folder to save the recording.
recorder resolution <audi- Sets the resolution that the recorder will record
o|720|1080> meetings. The default is 720p30. Selecting 1080 allows
the recorder to do p30. (From version 2.4.)
Note: The Streamer is not available on the Cisco Meeting Server 2000.
This section provides a command reference for the Streamer. Follow the instructions in the
appropriate deployment guide to deploy the streamer.
Command/Examples Description/Notes
streamer sip certs Allows you to configure a SIP certificate. (Added from ver-
sion 3.0.)
streamer limit <value|none> Sets the streamer limit to allow scalability. This is the limit
above which calls are rejected so that call control can fail
over to another device. Added from version 3.0.
streamer sip listen <interface> The SIP recorder/streamer components do not need to
<tcp-port|none> <tls-port|none> listen for https connections, however, they do need to
listen for SIP connections. This new MMP command is
introduced for setting both TCP and TLS. (Added from ver-
sion 3.0.)
streamer (enable|disable) Enables or disables the Streamer. You need to disable the
Streamer before configuring it. After configuration, you
need to enable the Streamer.
meetingapps https Configures the interface and port for the MeetingApps to listen on.
listen <inter-
face> <port>
meetingapps https Removes the interface and port configuration for the MeetingApps.
listen none
meetingapps gen- Generates the key that will be used to authenticate the Web Bridge and MeetingApps
secret connection.
meetingapps https Configures the HTTPS certificates for the MeetingApps. It is recommended to use pub-
certs <key-file> licly trusted HTTPS certificate signed by a valid certification authority (CA).
<crt-fullchain-
file>
webbridge3 Configures the MeetingApps hostname, port number, and the secret key generated
meetingapps add using the meetingapps gensecret command.
<hostname> <port>
<secretkey>
12 Miscellaneous Commands
12.1 Model
Command/Examples Description/Notes
Command/Examples Description/Notes
Note: motd commands are only supported on Meeting App versions prior to version 1.9.
Command/Examples Description/Notes
motd add "<message text>" Displays a banner with <message> after login
Alternatively, a message no larger than 2048 characters can be
configured by copying a file by SFTP to "motd".
Command/Examples Description/Notes
Command/Examples Description/Notes
Note: Meeting Server 2000 does not support SNMP, therefore the snmp commands will not be
available.
Place these files on your SNMP implementation's search path Te.g. ~/.snmp/mibs for Net-
SNMP.
Note: The MIBs will be renamed in a future release to reflect the rebranding to Cisco Meeting
Server.
The MMP interface only provides a minimal amount of user configuration options. To handle
more complex requirements, use the MMP interface to create an initial user and then manage
the user database directly - for example with snmpusm from the Net-SNMP package.
The Meeting Server supports both SNMP versions 1/2c and 3: the configuration is different for
each. Be aware of the security implications of using SNMP version 1/2c: it does not support
robust authentication and therefore anyone who knows the community string can query the
server.
Command/Examples Description/Notes
snmp community add <name> [IP Access control for v1/2c is based on
address/prefix] "communities". These can be created and deleted
snmp community del <name> via the MMP when SNMP is disabled.
Note: Only use alphanumeric and underscore in
the SNMP community name, other "special"
characters, including dash, will return an error
message.
snmp community add public Allows access to the complete tree from anywhere
using the community string "public".
snmp community add local 10.1.0.0/16 Allows access but only from the specified subnet.
Command/Examples Description/Notes
Command/Examples Description/Notes
of capacity.
If log data must be retained for compliance or other reasons, and a remote syslog server is not in
use, you can:
n Connect to the MMP using a SFTP tool and copy the system log file off the server to a local
file store. This leaves the current contents intact
n Save the log file permanently using the syslog rotate <filename> command. The active
system log is then emptied. This saved file can be downloaded using SFTP
For example: syslog rotate mylog
n A user with the audit role can save the audit log with syslog audit rotate <filename>
Command/Examples Description/Notes
Note: Each time this command is executed the latest log bundle
replaces the log bundle that was generated earlier.
5. Rename the file, changing the logbundle part of the filename to identify which server
produced the file. This is important in a multi-server deployment.
6. Send the renamed file to your Cisco Support contact for analysis.
Initial file size of the log bundle.tar.gz is 1 Kb, after transfer via SFTP the size will increase
depending on the number of files and their size.
Note: In the event that you are not able to download the logbundle due to a slow network
connection between a computer and the Meeting Server, you can download the log and
live.json files to send to Cisco Support.
Command/Examples Description/Notes
df Displays disk usage for both the MMP and MODULE 0 as the percentage
usage per partition and the percentage inode usage.
Command/Examples Description/Notes
backup snapshot <name> Creates a full Meeting Server snapshot. A file <name>.bak is created
for download over SFTP. We strongly recommend using this command
regularly. The file name can have a maximum character limit of 256.
backup rollback <name> Restores the system for the backed up server, this involves rolling back
the configuration for the server. If not already on the Meeting Server
the backup file must be uploaded to the Meeting Server using SFTP
prior to running this rollback command. The file name can have a
maximum character limit of 256.
Note: This command overwrites the existing configuration as well as
the license.dat file and all certificates and private keys on the system
and reboots the Meeting Server. Therefore it should be used with
caution. If you restore this backup to another server, you must copy
your existing license.dat file and certificates beforehand because they
will be overwritten during the backup rollback process. The license.dat
file is keyed to the servers MAC address so will fail when restored from
a backup from another server and will need to be replaced after the
server is back online.
Command/Examples Description/Notes
upgrade [<filename>] Upgrades the Meeting Server. You must have uploaded the image file of
the version that you want to upgrade to before issuing this command.
When upgrading, a full system backup is created automatically. The
backup name is derived from the current software version. For example,
if the upgrade is from R2.9 to R3.0, the backup will be called 2_9.bak.
The default filename if one is not provided is upgrade.img
From version 3.0 this command performs signature and integrity checks
before proceeding with upgrading Meeting Server with the specified
image. The checks will be carried out even if the upgrade <name>
verify command has been previously run on that image. Updated from
version 3.0.
From version 3.7, Meeting Server identifies if the database cluster is
enabled in the server configuration and accordingly notifies the user to
uncluster the nodes before upgrading. Users can choose to abort the
upgrade process by pressing CTRL+C within 20 seconds.
upgrade delete <name> Upgrade images persist until they are deleted using SFTP or this CLI
upgrade delete upgrade.img command
upgrade <filename> verify Carries out all the integrity and signature checks normally done during
upgrade, but does not proceed with the upgrade. This command can
also be used to display the image type. Added from version 3.0.
authenticity Displays all information relating to software authenticity: how the run-
ning image was validated (key type and name), and the public keys cur-
rently loaded along with their details (type, name and source). It also
displays whether the keys are trusted: if a SPECIAL key is installed,
whether its signature has been verified with the MASTER key (other
keys are internal and always trusted). Added from version 3.0.
authenticity key add Installs a SPECIAL key. Only one SPECIAL key may be installed at a
<key-file> time. Added from version 3.0.
authenticity key none Removes the SPECIAL key currently installed. This command must be
used to remove a key before installing another, or when the key is no
longer in use. Added from version 3.0.
Command/Examples Description/Notes
factory_reset (full|app) The "full" option removes all user configuration: any credentials
installed on the system will be lost. Afterwards, you must deploy the
Meeting Server again.
The "app" option removes Active Directory sync data and space
(coSpace), Lync and SIP configuration; but MMP configuration
remains.
After the command completes, the system will reboot.
Command/Examples Description/Notes
callbridge trust xmpp <trusted xmpp Configures the Call Bridge to use a particular allowed
certificate allowed list list of certificates to validate the identity of the XMPP
servers. (From version 2.4)
callbridge trust xmpp none Removes the XMPP certificate allowed list from the
Call Bridge trust store. (From version 2.4)
Command/Examples Description/Notes
Command/Examples Description/Notes
xmpp listen <interface allowed Sets up an allowed list of interfaces to listen on. You must
list|none> enable the service in order to start listening with the
command xmpp enable
Stops the XMPP server listening
xmpp listen a b
xmpp listen none
xmpp certs <key-file> <crt-file> Defines the name of the key file and certificate file for the
[<crt-bundle>] XMPP server, and optionally, a CA certificate bundle as
provided by your CA.
xmpp motd add <message> Configures a "message of the day" which will be displayed
when Cisco Meeting App or XMPP clients log in. ""
xmpp max_sessions <number> Limits the number of simultaneous XMPP sessions that an
individual user can have with the XMPP server (and hence,
the number of simultaneous logins). This prevents a single
user from exhausting system resources.
xmpp max_sessions none Removes any restriction on the XMPP sessions per user.
xmpp max_sessions 3 If the expectation is that a user will have at most an iPad,
iPhone and PC login, then set the maximum sessions to
three.
xmpp callbridge add <component Configures the XMPP server to allow connections from a
name> new Call Bridge. Note: a secret will be generated, this is
required if you set up XMPP resiliency. Now go to the Web
Admin Interface on that Call Bridge and configure it to
connect to the XMPP server.
xmpp callbridge del <component Stops a Call Bridge from accessing the XMPP server.
name>
Command/Examples Description/Notes
xmpp callbridge list For each Call Bridge lists the domain, component_secret
and connection status
xmpp callbridge add-secret Required for XMPP resiliency. Used to add to the other
<callbridge> nodes in the XMPP cluster, the secrets generated from
connecting the Call Bridges to the first node in the cluster.
Command/Examples Description/Notes
loadbalancer list [<tag>] Lists the all the load balancer configurations or, if tag is
provided, just that load balancer’s configuration
loadbalancer trunk <tag> <iface> Configures the trunk interface and port
[:<port>]
loadbalancer trunk exampleEdge a:3999 Configures the public interface and port (for accepting
loadbalancer public <tag> <iface> client connections)
[:<port allowed list>] In a common edge deployment, the Web Bridge is also
loadbalancer public exampleEdge b:5222 enabled and needs to make use of a Core to Edge trunk.
loadbalancer public exampleEdge b:5222 To allow this, configure the loopback interface as a public
lo:5222 interface
loadbalancer auth <tag> <key-file> Configures the private key and certificate used to
<cert-file> <trust-bundle> authenticate to the trunk, and the trusted certificates
loadbalancer auth exampleEdge acano.key which may be presented by the trunk.
acano.crt trust.pem If a trunk presents any of the certificates in the trust
bundle when creating the TLS connection and the trunk
accepts the certificate that the load balancer presents,
then the connection will succeed. Specifically, if the trust
bundle contains a valid chain of certificates, with the
presented certificate issued by a CA at the end of the
chain, then authentication will succeed. Otherwise, the
connection will be rejected. In particular, if self-signed
certificates are used, then the public certificate can be
put into the trust bundle and authentication will succeed.
Command/Examples Description/Notes
trunk list [<tag>] Lists the all the Core configurations or, if tag is
provided, just that Core’s configuration
trunk create <tag> <port or service Creates a trunk instance for XMPP.
name>
trunk create trunktoExampleEdge xmpp
trunk edge <tag> <edge name|ip Configures the domain name or IP address of the
address>[:<port>] Edge to trunk to. Note that the domain name could
resolve to multiple IP addresses. In that case, a
connection is attempted to all addresses. If no port is
specified, it is assumed that the port can be
discovered by a DNS SRV lookup of the domain
name
trunk auth <tag> <key-file> <cert- Configures the private key and certificate used to
file> <trust-bundle> authenticate to the Edge server, and the trusted
certificates which may be presented by the Edge
server.
trunk debug <tag> This command is only to be used under the guidance
of Cisco Support. The diagnostics show:
l the DNS results for the Edge server name
l attempts to create the TLS connection and
authenticate to each address
l if successful, debug information from the Core
server, including:
l a list of "Core" connections (trunk to Edge
server connections) to the Edge server in
question
Command/Examples Description/Notes
xmpp multi_domain add <domain name> Add another domain that the XMPP server will listen
<key-file> <crt-file> [<crt-bundle>] to. Specify the private key, certificate and optional
certificate bundle as provided by the CA. Restart the
XMPP server for this change to take effect. Note: the
XMPP server will not start if the private key or
certificate files are missing or invalid.
xmpp multi_domain del <domain name> Delete the domain that the XMPP server listens to.
xmpp multi_domain list List the domain that the XMPP server listens to.
Command/Examples Description/Notes
xmpp cluster trust <trustbundle.pem> Specifies the bundle of certificates that will be
trusted by the xmpp cluster. The <trustbundle.pem>
should contain all of the certificates for the xmpp
servers in the cluster. The certificates must already
have been applied to the xmpp servers using
the xmpp certs command. This mechanism ensures
that the different xmpp nodes in the cluster trust
each other, and enables the failover operation and
the forwarding of traffic between nodes.
xmpp cluster status Reports the live state of the xmpp cluster. If the
cluster has failed, then this command will return the
statistics of the xmpp server running on this Meeting
Server only. Use this command to try and help
diagnose connectivity problems.
xmpp cluster join <cluster> Add this node to the cluster. <cluster> is the IP
address of the first node in the cluster (see command
xmpp cluster initialize).
xmpp cluster remove Remove this node from the cluster. This requires the
node to be running.
Command/Examples Description/Notes
xmpp cluster remove <node> Removes the specified node from the cluster, where
<node> is either the IP address or a domain name for
the node. This allows you to remove a node from the
cluster if the node is unresponsive.
xmpp callbridge add-secret Add Call Bridge secret to XMPP server. Used to
<callbridge> configure the other nodes with the secrets created
when connecting the Call Bridges to the first XMPP
Please enter a secret: <secret>
server node in the cluster.
This command allows a Call Bridge to share
credentials with many XMPP servers.
Table 7: Removed Web Bridge commands (for setting up legacy Web Bridge 2)
Command/Examples Description/Notes
webbridge listen <a|b|c|d|none Sets up the interface(s) and port(s) for the Web Bridge to
[:<port>] allowed list> listen on. You must enable the service to start listening with
webbridge listen a b the command webbridge enable. The default for the optional
port argument is 443.
webbridge certs <keyfile-name> Provides the name of the key file and .crt file for the Web
<crt filename> [<crt-bundle>] Bridge and, optionally, a CA certificate bundle as provided by
your CA
webbridge clickonce <url|none> Defines the clickonce link location. The url must be prefixed
by http://, https:// or ftp:// and be a valid url. If a user follows
a call invite link or coSpace web link (e.g.
https://www.join.cisco.com/invited.sf?id=1234) using
Internet Explorer (the only browser that we support for
clickonce), then we will attempt to redirect the user to the
configured clickonce location, rather than using the default.
When this redirect occurs, the PC Client starts automatically
(or is downloaded if it is not already installed) and the
call/coSpace will be dialed.
Command/Examples Description/Notes
webbridge msi (<url>|none) Configures the download locations for Windows msi, Mac
webbridge dmg (<url>|none) OSX dmg and iOS installers which are presented to WebRTC
webbridge ios (<url>|none) users
webbridge ios none To deconfigure, use the appropriate command with the para-
meter none
webbridge trust <crt-bundle|crt- Controls which Call Bridge instances are allowed to
file> configure guest accounts and customizations (like
webbridge trust none background image).
If the trusted Call Bridge is running on the same server as the
Web Bridge, then issuing the webbridge trust command with
the name of the Call Bridge public certificate/certificate
bundle is sufficient. If the Call Bridge is running on another
server, the public certificate/certificate bundle of the Call
Bridge must first be copied to the Web Bridge server using
SFTP.
Note: In clustered Call Bridge deployments, if the Call
Bridges have different certificates then combine the
certificates into one bundle.
webbridge trust xmpp <trusted Configures the Web Bridge to use a particular allowed list of
xmpp certificate allowed list> certificates to validate the identity of the XMPP servers.
(From version 2.4)
webbridge trust xmpp none Removes the XMPP certificate allowed list from the Web
Bridge trust store. (From version 2.4)
webbridge options <feature_name1 Switches on the specified features, if more than one feature
feature_name2> is to be enabled then separate the feature_names with a
space. Only use this command under instruction from Cisco
webbridge options cma.webrtc.ios
Support or Cisco EFT. These features are not suitable for
production use.
The features will remain enabled across reboots, but will be
automatically cleared when using the upgrade command.
(From version 2.5).
webbridge options none Switches off all features that were previously switched on
using the webbridge options <feature_name> com-
mand. Only use under instruction from Cisco Support or
Cisco EFT. (From version 2.5).
Command/Examples Description/Notes
callbridge add edge <ip Adds the SIP Edge for the Call Bridge to use.
address>:<port>
callbridge trust edge <certificate Specify a certificate for the Call Bridge to trust for
file> connections to and from the SIP Edge. This is the
certificate of the SIP Edge.
sipedge private <interface>:<port> Specify the internal interface and port for connections
to and from the Call Bridge
sipedge public <interface>:<port> Specify the external interface and port for
connections to and from external systems
sipedge public-ip <address> Configure or remove the NAT address that the SIP
Edge can be reached at.
sipedge public-ip none
sipedge certs <key-file> <crt-file> Configure the private key and certificate for the SIP
<trusted-bundle> Edge along with a bundle of trusted certificates for the
connection from the Call Bridge
sipedge disable
sipedge restart Restarts the SIP Edge component. Use this command
after you have changed the certificates on the SIP
edge. Do not use this command when important calls
are active.
Table 9: Removed commands to configure the Meeting Server to accept and send H.323 calls
Command/Examples Description/Notes
h323_gateway certs <keyfile> Defines the name of the private key file and .crt file for the
<certificate file> [<cert- H.323 Gateway application and, optionally, a CA certificate
bundle>] bundle as provided by your CA. (Also see the section
Provisioning with Certificates.)
Command/Examples Description/Notes
h323_gateway h323_nexthop Connect to this IP address for all outgoing H.323 calls and let
<host/ip> the device at this IP address handle the routing. If this address
h323_gateway del h323_nexthop is not set, only IP dialing works.
Typically this IP address is a Cisco VCS/Polycom DMA, and an
H.323 trunk is established between the Cisco Meeting Server
H.323 Gateway and the third party device (H.323 Gatekeeper).
The H.323 Gateway does not register with the device, just
forwards calls to them – the device will need to be configured
appropriately to accept these calls.
h323_gateway sip_domain <uri> Optional. If an incoming H.323 call is made to the gateway
without a domain in the destination address, @<sip_domain>
h323_gateway del sip_domain
will be appended to the destination address before the SIP call
<uri>
to the Call Bridge is made.
h323_gateway h323_domain <uri> Optional. If an H.323 call is made to the gateway without
including a domain in the source address, @<h323_domain>
h323_gateway del h323_domain
will be appended to the source address before the SIP call is
<uri>
made.
h323_gateway h323_interfaces Must be configured in order for gateway to start, but the actual
<interface list> setting is currently ignored.
h323_gateway sip_interfaces
<interface list>
Command/Examples Description/Notes
h323_gateway sip_port <port> Ports for the SIP side to listen on. The default is 6061.
Note: if you wish to change the default port from 6061, and if
the H.323 Gateway and Call Bridge are on the same server,
make sure you avoid port 5061 which is used by the Call
Bridge. Changes do not take place until the gateway is
restarted.
The H.323 Gateway always expects TLS connections;
therefore, "Encrypted" should be selected on outbound dial
plan rules on the Call Bridge
h323_gateway sip_proxy <uri> Set this to the IP address of the Call Bridge, or for multiple Call
Bridges use the domain name (through DNS). All incoming
H.323 calls will be directed to this uri
If the Call Bridge and the H.323 Gateway are on the same host
then use IP address 127.0.0.1. If the Call Bridge and the H.323
Gateway are on different hosts then use the IP address of the
Call Bridge.
h323_gateway restrict_codecs If set to yes, the H.323 Gateway is limited to a safe set of
<yes/no> codecs that are less likely to cause interoperability problems.
Currently this set is G.711/G.722/G.728/H.261/H.263/
H.263+/H.264.
Codecs disabled by this feature are G.722.1 and AAC.
Command Description
recorder listen <a|b|c|d|lo|none Sets up the interface(s) and port(s) for the Recorder to
[:<port>] allowed list> listen on. You must enable the service to start listening with
recorder listen a b the command recorder enable. The default for the optional
port argument is 443.
Command Description
streamer trust <crt-bundle|crt- Controls which Call Bridge instances are allowed to
file> connect to the Recorder.
If the trusted Call Bridge is running on the same server as
the Recorder, then issuing the recorder trust command with
the name of the Call Bridge public certificate/certificate
bundle is sufficient. If the Call Bridge is running on another
server, the public certificate/certificate bundle of the Call
Bridge must first be copied to the server with the enabled
Recorder using SFTP.
Command Description
streamer listen <a|b|c|d|lo|none Sets up the interface(s) and port(s) for the Streamer to
[:<port>] allowed list> listen on. You must enable the service to start listening with
recorder listen a b the command streamer enable. The default for the optional
port argument is 443.
streamer certs <keyfile-name> Provides the name of the key file and .crt file for the
<crt filename> [<crt-bundle>] Streamer and, optionally, a CA certificate bundle as
provided by your CA
streamer trust <crt-bundle|crt- Controls which Call Bridge instances are allowed to
file> connect to the streamer.
If the trusted Call Bridge is running on the same server as
the streamer, then issuing the streamer trust command with
the name of the Call Bridge public certificate/certificate
bundle is sufficient. If the Call Bridge is running on another
server, the public certificate/certificate bundle of the Call
Bridge must first be copied to the server with the enabled
streamer using SFTP.
streamer listen <a|b|c|d|lo|none Sets up the interface(s) and port(s) for the Streamer to
[:<port>] allowed list> listen on. You must enable the service to start listening with
recorder listen a b the command streamer enable. The default for the optional
port argument is 443.
Cisco Trademark
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates
in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their
respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (1721R)