Please note that the Men & Mice command line is no longer being maintained
and will be deprecated in a future version of the Men & Mice Suite.

Below you will find a description of every command supported by the CLI. 

In many commands you can use a hyphen (-) instead of <zonename> to specify the last zone used.

Example: To save the changes in the last zone you made changes to

save -

If more than one zone with the same name is available, you might need to refer to it directly by specifying the server name and the view in which it is located.

The format is <server name>:<view name>:<zone name>

On servers without views (i.e. Microsoft servers), the <view name> is left empty. Example:

print mainserv::azone.com.


add <zonename> <recno> <record>
Adds a record to a zone.  Providing <recno> as -1 adds the record at the end of the zone.

addDevice <address> n=<name> [<CFx>=<value>]*
Adds a device to the enclosing IP range. The IP Address <address> is locked for use in DNS.  You can set a custom propery by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

addDHCPServer <server> [<proxy>] type=(MS|ISC|IOS) [user=<value>] [password=<value>] [<CFx>=<value>]*
Adds a DHCP server to the list of known servers. The user and password parameters are only used for Cisco IOS servers.  In case of an MS or a Cisco server, you must specify the location of the dhcpremote proxy (use 127.0.0.1 if it is running on the same machine as Central). You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

addIPRange <IP range> title="IP Range title" [subnet=t/f] [locked=t/f] [autoassign=t/f] [sc=<save comment>] [<CFx>=<value>]*
Adds an IP range. The range address <IP range> can be in one of the following formats:

      1.2.3.0/24
      1.2.3/24
      1.2.3.1-1.2.3.2
      1.2.3.0 mask 255.255.255.0

You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

Example: addIPRange 10.10.10.0/24 title="Internal" subnet=t custom="My range"

addScope <subnet> <server> <title> [c=<comment>] [sc=<save comment>] [<CFx>=<value>]*
Adds a scope to a DHCP server.  You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

addServer <server> [<address>] [<CFx>=<value>]*
Adds a name server to the list of known servers.  You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

addSlaveZone <zonename> <server> <master address>+
Adds a slave zone to a server. There must be at least one master IP address.

addZone [-DS] <zonename> <server> [* | <slave>+] [<CFx>=<value>]*
Adds a zone to a list of servers. The -DS argument specifies that the zone created should be an Active Directory zone. Slave servers are optional more than one can be specified.  An asterisk (*) can be used instead of explicitly specifying slave servers.  If the asterisk is used, a slave zone will be created on all servers besides the master server.  You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

backup [-f] [<path>]
Creates a backup of the Men & Mice Central database.  If no pathname is specified, the backup file will be created in the Men & Mice Central data directory. If a backup file already exists and the -f argument is not provided the command will fail with an error.

close <zonename>
Closes a zone without saving changes.

closeAll
Closes all zones without saving changes.

defaultTTL <zonename> [<value>]
Gets or sets the default TTL for a zone. If no value is provided the command returns the current TTL value.  Note: This command will only work for static zones on BIND servers.

delete <zonename> <recno>
Deletes a record in a zone.

deleteZone <zonename> [<server>+]
Deletes a zone. You can specify more than one server from which to remove the zone.  If no servers are provided the zone will be removed from all servers.

delRec <zonename> <recname> <rectype> <recdata>
Deletes all records that match <recname>, <rectype> and <recdata> from the zone <zonename>. Instead of <recdata> you can specify a wildcard * that will match all data values.

DHCPServer <ServerAddress> <command>
Perform various actions on DHCP servers. The following commands are supported:

show optionvalue [all]

   - Show DHCP server options

set optionvalue [sc=<savecomment>] [<field>=<value>,[<value2>]*]

   - Set DHCP server option

delete optionvalue <OptCode>

   - Delete DHCP server option

show properties [all]

   - Show DHCP server properties

set property [sc=<savecomment>] [<field1>=<value1>] [<field2>=<value2>]* 

   - set DHCP server properties.

 

DHCPServers
Lists all available DHCP servers.

disable <zonename> <recno>
Disables a record in a zone.

echo <text>
Echoes <text> to current output.

edit <zonename> <recno> <record>
Changes the contents of record <recno>. The new record must be of the same type as the old one.

enable <zonename> <recno>
Enables a record in a zone.

execute <filename>
Executes a script file.

export [-aging] <zonename> <filename>
Exports a zone to an external file. -aging argument specifies that if this is a Windows zone that has scavenging active the zone file will contain the aging values for each record

findRec <zonename> <recname> <rectype> <recdata>
Finds all records that match <recname>, <rectype> and <recdata> from the zone <zonename>. Instead of <recdata> you can specify a wildcard * that will match all data values.

help [<command>]
Prints out help information.  If a command name is provided as an argument, detailed information about that command will be displayed.

history [zone=<zonename>] [user=<username>] [fmt=(ymd|dmy|mdy)] [from=<fromdate>] [to=<todate>] [data=<text>] [limit=n]
Queries the history log. You can filter the results by zone name, user name, data and a date range. You can also use the limit parameter to specify the maximum number of entries to return (the default limit is 1000 entries).

import [-DS] [-aging] <zonename> <server> [ * | <slave>+ ] <filename>
Imports a zone from an external file. The -DS argument specifies that the zone created should be an Active Directory zone. The -aging argument specifies that if this zone is created on a Microsoft Windows server and <filename> is a zone file that contains aging values for records, those values will be honored when the zone is created.

ipRanges [-d] [-e] <filter>*
Lists all available IP ranges. If the -d argument is specified, detailed information is displayed. If the -e argument is specified all ranges are displayed using the <from>-<to> format.  The filters can be one or more specifying names of a label and values of a custom property. The format of the filter is: [<label>:<value>]. Example: [Responsible Person:Joe]

isConnected
Returns true if we are connected to a Men & Mice Central server.

listHosts [-f] <IP range>
Lists all host in an IP range.  If the range contains more than 4096 IP addresses and -f is not provided the command will warn the user and ask whether it should continue.  The IP range can be in one of the following formats:

      1.2.3.0/24
      1.2.3/24
      1.2.3.1-1.2.3.2
      1.2.3.0 mask 255.255.255.0

login <server> <username> [<password>]
Logs on to the Men & Mice Central server.  If <password> is omitted, you will be prompted for the password.

logMessages [data=<text>] [from=<fromdate>] [to=<todate>] [fmt=(ymd|dmy|mdy)]
Shows the system log messages.

modifyDevice <address> [n=<name>] [<CFx>=<value>]*
Modifies a device. You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner.

modifyIPRange <IP range> [subnet=t/f] [locked=t/f] [autoassign=t/f] [sc=<save comment>] [<CFx>=<value>]*
Modifies an IP range. You can set a custom property by the name of <CFx> to the value <value>.  More than one custom property value can be defined in this manner. The range address <range address> can be in one of the following formats:           

      1.2.3.0/24
      1.2.3/24
      1.2.3.1-1.2.3.2
      1.2.3.0 mask 255.255.255.0

Example: modifyIPRange  10.10.10.0/24 locked=t

modifyZoneOptions <zonename> [allow-xfer=all|none|ns|<servers>] [notify=all|none|<servers>]
Modifies options for a master zone on a Windows DNS Server.  The <servers> argument is a comma separated list of IP addresses.

open <zonename>
Opens and reads a zone from server.

print [-l] <zonename> [<range>]
Prints out a zone. <range> is optional and can be on the form <num>[-<num>]. If the -l argument is specified line number are printed along with each record.

prompt [on/off]
Changes the prompting mode.  With prompting on, the user is questioned about all drastic changes he is about to make. With prompting off, the user is never prompted. If no argument is given, the program prints out whether prompting is on or off.

quit
Quits the program.

refresh [<zonename>]
Reloads a zone from a server. If no zone is specified then the list of known zones and servers is refresh.

reloadZones [<server>]
Reloads the list of zones from a server. If no server is specified then the list of zones is reloaded from all servers. This command differs from refresh in that it forces all server configurations to be re-read.

rem
A remark. The rest of the line is ignored.  The # character can also be used to indicate a remark.

removeDevice <address>
Removes a device.

removeDHCPServer <server> [sc=<save comment>]
Removes a DHCP server from the list of known servers.

removeIPRange <IP range> [sc=<save comment>]
Removes an IP range. The IP range can be in one of the following formats:

      1.2.3.0/24
      1.2.3/24
      1.2.3.1-1.2.3.2
      1.2.3.0 mask 255.255.255.0

removeScope <ScopeAddress> [server=<ServerAddress>] [sc=<savecomment>]
Removes a scope from a DHCP server.

removeServer <servername>
Removes a server from the list of known servers.

revert <EventItem ID>+
Reverts a DNS event. You can specify more than one ID of events to be reverted.

save <zonename> [range=<ip range>] [sc=<comment>]
Saves changes made to a zone.  <ip range> is the IP address range to use for auto assignment of IP addresses for A records.

The IP range can be in one of the following formats:

      1.2.3.0/24
      1.2.3/24
      1.2.3.1-1.2.3.2

sendMessage <message>

Sends a message to all Men & Mice Consoles. You must have administrator privileges to be able to send a message.

scope <ScopeAddress> <command>
Perform various actions on DHCP scopes. The following commands are supported:

enable [server=<ServerAddress>]
Enable a scope on a DHCP server.

disable [server=<ServerAddress>]
Disable a scope on a DHCP server.

show reservedip
Displays all reservations in a scope.

show excluderange
Displays all excluded ranges in a DHCP scope.

show iprange
Displays all address pools in a DHCP scope.

show clients
Displays all clients in a DHCP scope.

show properties
Displays properties and custom properties of a DHCP scope.

<ServerAddress> add excluderange <StartIP> <EndIP> [sc=<savecomment>]
Adds an excluded range to a DHCP scope.

<ServerAddress> delete excluderange <StartIP> <EndIP> [sc=<savecomment>]
Deletes an exclude range from a DHCP scope.

<ServerAddress> add iprange <StartIP> <EndIP> [sc=<savecomment>]
Adds an address pool to a DHCP scope.

<ServerAddress> delete iprange <StartIP> <EndIP> [sc=<savecomment>]
Deletes an address pool from a DHCP scope.

add reservedip <ReservedIP> <MAC_Address> n=<ClientName> [c=<ClientComment>] [t=<ClientType>(DHCP | BOOTP | BOTH)] [d=<DDNSHostName>] [sc=<savecomment>]
Adds a reservation to a DHCP scope. The c=<ClientComment> argument is for MS DHCP only

delete reservedip <ReservedIP> <MAC_address> [sc=<savecomment>]
Deletes a reservation from a DHCP scope.

set property [sc=<savecomment>] [<field1>=<value1>] [<field2>=<value2>]* 

Set properties for scope.

show optionvalue 
Shows DHCP scope options.

[<ServerAddress>] set optionvalue [sc=<savecomment>] [<field>=<value>,[<value2>]*]

Set DHCP scope option.

[<ServerAddress>] delete optionvalue <OptCode>
Deletes a DHCP scope option.

show reservedoptionvalue <ReservedIP>
Shows DHCP scope reservation options.

set reservedoptionvalue <ReservedIP> [<field>=<value>[,<value2>]*] [sc=<savecomment>]
Sets a DHCP scope reservation option.

delete reservedoptionvalue <ReservedIP> <OptCode>
Deletes a DHCP scope reservation option.

scopes [-s] [-d] [<server>]
Lists DHCP scopes. If <server> is specified then it will only list scopes on that server. If the -s parameter is used, the command considers split scopes when calculating free addresses in address pools.  When the -d parameter is used availability of free addresses for individual split scope instances is also displayed.

serverInfo <server>
Lists information about a server.

servers
Lists all servers available.

sleep <sec>
Sleeps for the specified number of seconds.

verify <zonename>
Syntax checks a zone.  Returns a list of syntax errors.  If no errors exist within the zone nothing is returned.

version
Returns the version number of the program.

who
Returns a list of users that are logged in.

zonehistory
Queries the history log. For detailed description of the command see the History command.

zoneInfo <zonename>
Displays information about a zone.

zoneModified <zonename>
Returns indication of whether a zone has been modified.  Returns true if zone is modified and needs to be saved.

zoneOptions <zonename>
Returns options for a zone.

zones [-n] [<server>]
Lists all available zones. If the -n argument is specified, zones are sorted alphabetically. If omitted, forward zones are listed first, then reverse zones, and finally slave zones.  The argument <server> is optional. If provided, the command only lists zones on the specified server.