Cisco Meeting Server 2 1 MMP Command Reference 2 1
Cisco Meeting Server 2 1 MMP Command Reference 2 1
1 Introduction 6
1.1 How to use this Document 6
1.2 Accessing the MMP 8
1.2.1 Virtualized depolyments (Cisco Meeting Server 1000 and specification
based VM servers) 8
1.2.2 Acano X-Series Servers 8
1.3 Transferring files to and from the MMP 8
1.3.1 Which files you see in the SFTP client 8
1.4 What MMP Commands are Available? 9
1.5 Writing and Completing MMP Commands 10
2 Network Commands 11
2.1 Network Interface (iface) Commands 11
2.2 IP Commands 11
2.2.1 IPv4 commands 11
2.2.2 IPv6 commands 12
2.3 Network Diagnostic Commands 13
2.3.1 IPv4 network diagnostic commands 14
2.3.2 IPv6 network diagnostic commands 14
2.3.3 Packet capture 14
2.4 QoS/DSCP Commands 14
3 DNS Commands 16
4 Firewall Commands 18
9 H.323 Commands 47
10 Miscellaneous Commands 49
10.1 Model 49
10.2 Meeting Server’s Serial Number 49
10.3 Message of the Day 49
10.4 Pre-login Legal Warning Banner 49
10.5 SNMP Commands 50
10.5.1 General information 50
10.5.2 SNMP v1/2c commands 50
10.5.3 SNMP v3 commands 51
10.5.4 SNMP trap receiver configuration 52
10.6 Downloading the System Logs 52
10.7 Password Recovery/First Boot for the Acano X-Series Server 52
10.8 Disk Space Usage 53
10.9 Backup and Restore System Configuration 53
10.10 Upgrading the Meeting Server 54
10.11 Resetting the Meeting Server 54
Change History
Date Change Summary
December, 2016 Updated for version 2.1, added commands for the Streamer
1 Introduction
The Cisco Meeting Server was formerly called the Acano Server. The Cisco Meeting Server is
now hosted on specific servers based on Cisco Unified Computing Server (UCS) technology as
well as on the Acano X-Series hardware, or on a specification based VM server.
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 Acano X-Series Servers, the MMP can be accessed via the serial Console port or
SSH on the Ethernet interface labeled Admin. 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.1 Virtualized depolyments (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.
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).
Some commands are followed by one or more examples in blue within the same table cell:
Command/Examples Description/Notes
iface (admin|a|b|c|d) <speed> Sets the network interface speed, duplex and auto-
(full|on|off) negotiation parameters
iface admin 1000 full
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
2 Network Commands
Command/Examples Description/Notes
iface (admin|a|b|c|d) <speed> Sets the network interface speed, duplex and auto-
(full|on|off) negotiation parameters
iface admin 1000 full
2.2 IP Commands
Note: In the virtualized deployment, there is no admin interface and therefore admin is not a valid
entry in the following commands; select from A, B, C or D.
Command/Examples Description/Notes
Command/Examples Description/Notes
ipv4 (admin|a|b|c|d) add Configures the interface with an ipv4 address with specified
<server IP address>/<Prefix prefix length and default gateway for egress packets. The
Length> <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 (admin|a|b|c|d) del Removes the IPv4 address on the specified interface
<server IP 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 (admin|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 quite specific routing
ipv4 (admin|a|b|c|d) route del scenarios whereby multiple interfaces are enabled, and you
<address>/<prefix length> want to ensure that traffic for a specific subnet is routed out
to the gateway of that particular interface
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
Note: In the virtualized deployment, there is no admin interface and therefore admin is not a valid
entry in the following commands; select from A, B, C or D.
Command/Examples Description/Notes
Command/Examples Description/Notes
ipv6 (admin|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
Note: In a virtualized deployment, there is no admin interface so <mmp|app> is not required. For
example, in an Acano X-Series Server deployment use:
ping (mmp|app) <target address|hostname>
Command/Examples Description/Notes
ping (mmp|app) <target Ping from the MMP or the application interfaces to the target IP
address|hostname> address or hostname
traceroute (mmp|app) To traceroute from the MMP interface or application interfaces to the
<target address|hostname> target IP address or hostname
Command/Examples Description/Notes
ping6 (mmp|app) <target Ping from the MMP or the application interfaces to the target IPv6
address|hostname> address or hostname
traceroute6 (mmp|app) To traceroute from the MMP interface or application interfaces to the
<target address|hostname> target IPv6 address or hostname
Command/Examples Description/Notes
pcap (admin|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.
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)
n low-latency (XMPP)
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
Note: In a virtualized deployment, there is no admin interface so <mmp|app> is not required. For
example, in an Acano X-Series Server deployment use:
dns (mmp|app) add forwardzone <domain-name> <server ip>
Command/Examples Description/Notes
dns (mmp|app) add trustanchor Adds a trust anchor for Domain Name System Security
<anchor> Extensions (DNSSEC).
Trust anchors should be specified in DNS Resource Record
dns mmp add trustanchor ". IN DS form inside quotation marks – see the example. See [1] for
19036 8 2 details.
49AAC11D7B6F6446702E54A1607371607A1A4
1855200FD2CE1CDDE32F24E8FB5"
Command/Examples Description/Notes
dns (mmp|app) add rr <DNS RR> To configure the DNS resolver(s) to return values which are
dns app 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 app add rr "_sip._ configured which will be returned instead of querying external
tcp.example.com. 86400 IN SRV 0 5 DNS servers.
5060 sipserver.local."
We accept RR records 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 (mmp|app) lookup Does name "lookups" of type A, AAAA or SRV from the
<a|aaaa|srv> <hostname> perspective of either the MMP or the application.
dns mmp lookup srv _xmpp-client._ The lookup "drills" through SRV results. That is, when an SRV
tcp.example.com record returns a domain name this is resolved by A and AAAA
lookups.
Note: If the application modules are not operational (e.g.
during booting or rebooting), then DNS lookups for "app" will
return no results.
dns (mmp|app) flush This flushes the DNS cache of either the MMP or the
application layer (API) of the Meeting Server.
4 Firewall Commands
The MMP supports the creation of simple firewall rules for both the media and admin 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 to configure the firewall, because using SSH
means that an error in the rules would make the SSH port inaccessible. If you must use SSH then
ensure an allow ssh rule is created for the ADMIN interface before enabling the firewall.
Command/Examples Description/Notes
firewall admin Displays the status and rule set for the ADMIN interface
Command/Examples Description/Notes
firewall admin allow http/tcp Allows TCP packets on port 80 on the admin interface
firewall a deny 678 Drops all packets on port 678 on media interface A
firewall admin allow ssh from Allows SSH access to the admin interface from the 256
192.168.1.0/28 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.
firewall admin delete 0 Deletes the single rule above this table.
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> <certificate> This command checks whether the specified key and a certificate
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
pki verify <cert> <cert service e.g. XMPP.
bundle/CA cert> [<CA cert>] A certificate may signed by a certificate authority (CA) and the CA
will provide a "certificate bundle" of intermediate CA certificates
and perhaps a CA certificate in its own file. To check that the
pki verify server.pem bundle.pem
certificate is signed by the CA and that the certificate bundle can
rootca.pem
be used to assert this, use this command.
pki verify server.pem bundle.pem
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:"Round the Attributes for the CSR can be specified in pairs with the attribute
corner" 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
pki selfsigned <key/cert For quick testing and debugging, self-signed certificates
basename> (http://en.wikipedia.org/wiki/Self-signed_certificate) can be
generated.
<key/cert basename> identifies the key and certificate which will
be generated e.g. "pki selfsigned new" creates new.key and
new.crt (which is self-signed).
Command/Examples Description/Notes
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.
Command/Examples Description/Notes
tls <service> Displays the configuration for a service , for example LDAP
or SIP.
tls < service > trust <crt bundle> Configures the system to use a particular bundle of
tls ldap trust ldap.crt certificates to validate the certificate of a remote service
tls <service> verify ocsp Enables verification with the additional requirement that
the remote service returns a 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.
Command/Examples Description/Notes
tls <service> ciphers <cipherstrin See note below for an explanation of when you might
g> need to use the tls cipher command.
The cipher string format is a colon separated list of ciphers
as used by OpenSSL (
https://www.openssl.org/docs/apps/ciphers.html#CIPHE
R-LIST-FORMAT). The current default for cipher support
is:
"ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH
+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH
+3DES:RSA+AESGCM:RSA+AES:RSA
+3DES:!aNULL:!MD5:!DSS"
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.
uptime Displays the time since the Meeting Server was last
rebooted
timezone <timezone name> Sets the time zone for the Meeting Server. The
timezone Europe/London Meeting 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 none Stops the Call Bridge and disables listening services;
however, the Call Bridge remains enabled.
callbridge prefer <interface> Choses one interface from the interface whitelist 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 5.)
callbridge restart Restarts the core media services. Note: Rebooting the
Meeting Server will disconnect any calls. The process
takes some minutes to complete.
Command/Examples Description/Notes
syslog server add <hostname> [<port>] The Meeting Server can send its log files to a remote
syslog server del <hostname> syslog server over TCP (not UDP)
syslog server add tls:syslog.example.com The port defaults to 514
514 To specify that TLS should be used to protect the
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 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 10.6 for details on downloading the
system logs
are carried out using this module and cryptographic operations are restricted to the FIPS-
approved cryptographic algorithms.
Command/Examples Description/Notes
Command/Examples Description/Notes
iface <interface> mtu <value> Sets the maximum transmission unit size in bytes for an
iface a mtu 1400 interface
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) 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.
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
Command/Examples Description/Notes
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|delete Restricts remote access for a user from hosts in a whitelist
<hostname> 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
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
n To prevent weak passwords you can upload a dictionary against which each new password
will be checked. If the new password matches an entry in the dictionary it will be rejected:
l The dictionary must be a text file called dictionary with one word or phrase to each
line
l Each line must end with a single line-feed character rather than the Windows
carriage-return line-feed sequence
l Upload the dictionary using SFTP to enable the checking e.g.
sftp>put passwordlist.txt dictionary
n There are a number of commands which enforce more secure password usage. All these all
commands require admin level access.
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
Command/Examples Description/Notes
user rule no_username Prevents a password being set that contains the user name.
<true|false>
user rule max_failed_logins Sets the number of failed login allowed before a 15 minute lockout
<attempts>
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. WARNING: accounts
created before R1.2—other than the account running this
command—will be locked by the setting. For each account to be
unlocked use the user unlock command above.
user rule max_sessions Limits any user to <number> simultaneous SSH sessions,
<number> <number> simultaneous webadmin sessions and, if not an account
with the webadmin role, one console session.
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)
Command/Examples Description/Notes
xmpp listen <interface Sets up a whitelist of interfaces to listen on. You must
whitelist|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. (Also see the section Provisioning
with certificates.)
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.
Command/Examples Description/Notes
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>
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.
See Section 8.4 for other commands to deploy XMPP
resiliency.
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
Command/Examples Description/Notes
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 whitelist>] 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
Command/Examples Description/Notes
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
l the client connections currently being
serviced by that Edge server
l memory usage statistics for the Edge server
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.
Note: the XMPP resiliency feature is a fully released feature in Cisco Meeting Server 2.1.0, and
supported for production environments.
XMPP resiliency provides fail-over protection for a client being unable to reach a specific XMPP
server in multi-server deployments. Refer to the Scalability and Resilience Deployment Guide for
the steps in setting up XMPP resiliency.
The MMP commands to configure the Meeting Server to deploy XMPP resiliency are listed in the
table below.
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.
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>] whitelist> 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.acano.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
parameter 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.
Command/Examples Description/Notes
turn tls <port|none> Select the port for the TURN server to listen on
Note: the Web Bridge and Turn Server cannot listen
on the same interface:port combination. To run both
on port 443 requires them to be run on separate
servers/VMs, or on different interfaces on the same
server/VM.
Command/Examples Description/Notes
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.)
turn credentials <username> Sets the 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
Note: SIP and Lync call traversal is a beta feature, only use in a test environment, do not use in a
production environment.
The SIP Edge component provides support for traversal of local firewalls for SIP endpoints and
Lync calls in split server deployments. The Call Bridge uses a TURN server within the Meeting
Server to traverse the local firewall and send the SIP signal via a new SIP Edge component. Refer
to the deployment guides for the steps in setting up SIP and Lync call traversal in a test
environment.
The MMP commands to configure the SIP Edge component are listed in the table below.
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
Command/Examples Description/Notes
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.
Command/Examples Description/Notes
webadmin listen (admin|a|b|c|d) Sets up the interface for the Web Admin Interface to listen
[<port>] on. To start listening, you must enable the service with the
webadmin listen a command webadmin enable.
webadmin listen a 443 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
Command/Examples Description/Notes
Note: MMP user accounts are also used to log in to the Web Admin Interface.
Command/Examples Description/Notes
database cluster status Displays the clustering status, from the perspective of
this database instance.
database cluster localnode This command must be run on the server that will host
<interface> the initial master 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
Note: Do not use the Admin interface for database
clustering.
database cluster initialize Creates a new database cluster, with this server’s
current database contents as the one and only
database instance—the master.
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.
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 master 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
database cluster certs <client_key> Enables encryption for remote connections only, with
<client_crt> <ca_crt> no server keys.
database cluster certs dbcluster_
client.key dbcluster_client.crt dbcluster_
ca.crt
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.
Command/Examples Description/Notes
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 master 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
Command/Examples Description/Notes
recorder listen <a|b|c|d|lo|none Sets up the interface(s) and port(s) for the Recorder to
[:<port>] whitelist> listen on. You must enable the service to start listening
recorder listen a b with the command recorder enable. The default for the
optional port argument is 443.
recorder certs <keyfile-name> <crt Provides the name of the key file and .crt file for the
filename> [<crt-bundle>] Recorder and, optionally, a CA certificate bundle as
provided by your CA
recorder trust <crt-bundle|crt- Controls which Call Bridge instances are allowed to
file> connect to the Recorder.
recorder trust none 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/Examples Description/Notes
recorder nfs Provides the Recorder with details of the network file
<hostname/IP>:<directory> server (nfs) and folder to save the recording.
streamer listen <a|b|c|d|lo|none Sets up the interface(s) and port(s) for the Streamer to
[:<port>] whitelist> listen on. You must enable the service to start listening
streamer listen a b with the command recorder enable. The default for the
optional port argument is 443.
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.
streamer certs <keyfile-name> <crt Provides the name of the key file and .crt file for the
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.
9 H.323 Commands
The MMP commands to configure the Meeting Server to accept and send H.323 calls are listed
in this section.
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.)
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 default_uri <uri> Optional. If an incoming H.323 call has no destination (normally
h323_gateway del default_uri only the case when the H.323 Gateway has been dialed by an
IP address) the SIP call is made to whatever default_uri is set.
The default_uri may point to an IVR, or directly into a coSpace.
If it is not set, the call is rejected.
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.
Command/Examples Description/Notes
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>
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.
10 Miscellaneous Commands
10.1 Model
Command/Examples Description/Notes
Command/Examples Description/Notes
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
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.
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.
snmpwalk -v 1 -c <community> <MMP- To test the configuration using v1/2c, use Net-
address> ACANO-HEALTH-MIB::acanoHealth SNMP's snmpwalk (http://net-
snmpwalk -v 1 -c public <MMP-address> ACANO- snmp.sourceforge.net/) on Linux (other tools are
HEALTH-MIB::acanoHealth available on Windows) – see the example on the
left.
Note: ACANO-HEALTH-MIB is only available on
theAcano X-Series Server, it is not available on
virtualized deployments.
Command/Examples Description/Notes
snmp user add <name> <password> (MD5|SHA) Access control for v3 is based on users.
(DES|AES) Creates a user with the specified password,
using the "MD5" algorithm for authentication
and the "DES" algorithm for encryption, with
access to the complete tree.
Command/Examples Description/Notes
You see the fan module on the left and a smaller area on the right with cables and connectors.
In this area and behind the front grill are two small buttons: one red (labeled reset) and one
black.
5. Carefully press the red (reset) button only.
6. Within four minutes of pressing this button log into the server using the terminal emulator:
user account is “admin”, no password will be requested.
7. Set up your admin account using the following command.
user add admin admin
Note: You can create multiple admin level accounts with different account names.
8. You are prompted for a password which you must enter twice.
Note: When you log in subsequently, either via the Console port or the interface labeled
Admin with the admin account created above and you will be asked for this password.
9. Close the hatch and push the screws down to secure the hatch, no screwdriver is needed.
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.
Command/Examples Description/Notes
backup rollback <name> Restores the system for the backup <name> (uploads the file and rolls
back the configuration.
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 R1.9 to R2.0, the backup will be called
1_9.bak.
The default filename if one is not provided is upgrade.img
upgrade delete <name> Upgrade images persist until they are deleted using SFTP or this CLI
upgrade delete upgrade.img command
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.
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. (1110R)