Fortinet FortiVoice 200D Reference Manual

Fortinet FortiVoice 200D Reference Manual

V2.0 mr1
Hide thumbs Also See for FortiVoice 200D:
Table of Contents

Advertisement

FortiVoice
200D/200D-T v2.0 MR1
CLI Reference

Advertisement

Table of Contents
loading

Summary of Contents for Fortinet FortiVoice 200D

  • Page 1 FortiVoice ™ 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 2 Fortinet, Inc., and other Fortinet names herein may also be trademarks of Fortinet. All other product or company names may be trademarks of their respective owners. Performance metrics contained herein were attained in internal lab tests under ideal conditions, and performance may vary.
  • Page 3: Table Of Contents

    35 extension preference ..................... 36 extension remote ....................41 extension ring-group....................42 extension user......................43 log setting remote ....................45 log setting local...................... 47 log alertemail recipient................... 49 Fortinet Technologies Inc. Page 3 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 4 ..................99 system route ......................100 system sip-setting....................101 system time manual ..................... 103 system time ntp ....................104 system voicemail ....................105 trunk office-peer ....................106 Fortinet Technologies Inc. Page 4 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 5 ......................... 137 telnettest ......................138 traceroute......................139 user-config......................140 get ........................141 system performance .................... 143 system status....................... 144 show & show full-configuration ..............145 Index ......................147 Fortinet Technologies Inc. Page 5 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 6: Using The Cli

    If you are new to Fortinet products, or if you are new to the CLI, this section can help you to become familiar.
  • Page 7: Enabling Access To The Cli Through The Network (Ssh Or Telnet)

    If your computer is not connected directly or through a switch, you must also configure the FortiVoice unit with a static route to a router that can forward packets from the FortiVoice unit to your computer. Fortinet Technologies Inc. Page 7 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 8 Telnet is not a secure access method. SSH should be used to access the CLI from the Internet or any other untrusted network. Fortinet Technologies Inc. Page 8 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 9: Connecting To The Cli Using Ssh

    8. Type a valid administrator account name (such as admin) and press Enter. You can alternatively log in using an SSH key. For details, see “system admin” on page Fortinet Technologies Inc. Page 9 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 10: Connecting To The Cli Using Telnet

    CLI commands. Command syntax When entering a command, the command line interface (CLI) requires that you use valid syntax, and conform to expected input constraints. It will reject invalid commands. Fortinet Technologies Inc. Page 10 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 11: Terminology

    Fortinet documentation uses the following conventions to describe valid command syntax. Terminology Each command line consists of a command word that is usually followed by words for the configuration data or other specific item that the command uses or affects:...
  • Page 12: Indentation

    A non-required word or series of words. For example: [verbose {1 | 2 | 3}] indicates that you may either omit or type both the verbose word and its accompanying option, such as: verbose 3 Fortinet Technologies Inc. Page 12 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 13 See “Special characters” on page • <xxx_int>: An integer number that is not another data type, such as 15 for the number of minutes. Fortinet Technologies Inc. Page 13 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 14: Sub-Commands

    (admin)# Applicable sub-commands are available to you until you exit the scope of the command, or until you descend an additional level into another sub-command. Fortinet Technologies Inc. Page 14 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 15 Save the changes to the current object and exit the config command. This returns you to the top-level command prompt. Fortinet Technologies Inc. Page 15 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 16 List the configuration of the current object or table. • In objects, get lists the table names (if present), or fields and their values. • In a table, get lists the fields and their values. Fortinet Technologies Inc. Page 16 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 17: Permissions

    FortiVoice configuration options, including viewing and changing all other administrator accounts. It is the only administrator account that can reset another administrator’s password without being required to enter the existing password. As Fortinet Technologies Inc. Page 17 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 18: Tips And Tricks

    Command memory is limited to the current session. Recall the next command. Down arrow, Ctrl + N Move the cursor left or right within the command line. Left or Right arrow Fortinet Technologies Inc. Page 18 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 19: Command Abbreviation

    Administrator'. value, not to Precede the space with a backslash: Security\ end the string) Administrator. (to be interpreted as part of a string value, not to end the string) Fortinet Technologies Inc. Page 19 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 20: Language Support

    To edit the configuration on your computer 1. Use backup to download the configuration file to a TFTP server, such as your management computer. Fortinet Technologies Inc. Page 20 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 21 If it is, the FortiVoice unit loads the configuration file and checks each command for errors. If a command is invalid, the FortiVoice unit ignores the command. If the configuration file is valid, the FortiVoice unit restarts and loads the new configuration. Fortinet Technologies Inc. Page 21 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 22: Config

    Fortinet Technologies Inc. Page 22 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 23: Customized-Message

    This sub-command is available from within the command customized-message. edit email-template-notify-generic config variable edit <name> content display-name config email-template edit default env-from <string> from <string> html-body <string> subject <string> text-body <string> to <string> Fortinet Technologies Inc. Page 23 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 24: Fv-Missed-Call-Notify

    Enter the display name for the variable. For example, the display-name display name for %%FILE%% can be notification. env-from <string> Enter the mail sender’s address. This is the address for bounce messages. Fortinet Technologies Inc. Page 24 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 25: Fv-Voicemail-Notify

    Enter the replacement message for the email body in text text-body <string> format. login-disclaimer Use this sub-command to configure the variables and the default content of the FortiVoice system login disclaimer. Fortinet Technologies Inc. Page 25 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 26 %%WARNING%% can be Disclaimer. Enter the replacement message for the login disclaimer. content <string> Select the format for the login disclaimer. format {html | multiline | html text} Fortinet Technologies Inc. Page 26 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 27: Dialplan Did-Mapping

    Currently, only the equivalent numbers can reach the mapped extensions when they dial the DID number. If you select dial-extension or dial voicemail extension <string> for fallback-action, enter the extension number. Fortinet Technologies Inc. Page 27 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 28 For some actions, you need to enter the extension, such voicemail | hang-up } as Dial voicemail. Enter the trunk used for dialing the DIDs. incoming-trunk <name> Enable or disable this DID setting. status {enable | disable} enable Fortinet Technologies Inc. Page 28 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 29: Dialplan Inbound

    For some actions, you need to enter the extension (such operator | dial-voicemail | as Go voicemail) or select a profile (such as Play hang-up | hang-up | announcement). lookup-name-directory | no-action | play- announcement} Fortinet Technologies Inc. Page 29 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 30 For example, send calls to the voicemail after business hours. Enter the trunk for the incoming calls that are subject to from-trunk <name> this dial plan. Fortinet Technologies Inc. Page 30 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 31 Create the number match following the pattern-matching syntax and pattern-matching examples in “pbx number- management” on page status {enable | disable} Enable or disable this dial plan. enable Fortinet Technologies Inc. Page 31 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 32: Config Dialplan Outbound

    <integer> outbound calls, enter the call delay time in seconds. Enter the caller ID modification configuration. modify-callerid <name> Enter the FortiVoice operation schedule for the action. schedule <name> Fortinet Technologies Inc. Page 32 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 33 “pbx number-management” on page status {enable | disable} Enable or disable this dial plan. enable option <emergency-call> Set to allow emergency call with this plan. Fortinet Technologies Inc. Page 33 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 34: Extension Group

    <group-name> member Variable Description Default Enter a name for the extension group. <group-name> Enter the existing extension numbers or extension group member names to include in this group. Fortinet Technologies Inc. Page 34 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 35: Extension Paging

    Enter the page group number following the extension number pattern. This is the number that, once paged, will ring all the extensions in the group. status {enable | disable} Enable or disable this page group. enable Fortinet Technologies Inc. Page 35 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 36: Extension Preference

    | extension-appearance | headset | hold | intercom | line-appearance | message | mute | no- configuration | no-function | one-key-dial | phone- book | pickup-transfer | redial | ringer-off | system- Fortinet Technologies Inc. Page 36 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 37 | ring-phone | voicemail} If you entered follow-me for action, enter a follow follow-me <name> me profile. sound-file <name> If you entered play-announcement for action, enter a sound file. Fortinet Technologies Inc. Page 37 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 38 • FortiFone 550i: 24 Note that keys 1 and 2 are reserved and cannot be programmed. <id> Enter the key number to which you want to map a function. Fortinet Technologies Inc. Page 38 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 39 {chinese- Enter the language for the FortiVoice user web portal. simplified | chinese- traditional | english | french | japanese | korean | portuguese | spanish} Fortinet Technologies Inc. Page 39 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 40 Enter the number representing the time zone for the FortiVoice user web portal. voicemail-pin <string> Change the default password for accessing the voice 123123 mailbox and the FortiVoice user web portal. Fortinet Technologies Inc. Page 40 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 41: Extension Remote

    <string> Enter the remote phone number to which a call to the local extension is transferred, using digits 0-9. status {enable | disable} Enable or disable this remote extension. enable Fortinet Technologies Inc. Page 41 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 42: Extension Ring-Group

    Enable or disable this ring group. status {enable | disable} enable Enter the amount of time in seconds allowing all timeout <integer> extensions or each one to ring before going to voicemail. Fortinet Technologies Inc. Page 42 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 43: Extension User

    <string> Enter the password used for configuring your SIP phone voice#321 from the phone or the Web. You need the phone's IP to access it from the Web. Fortinet Technologies Inc. Page 43 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 44 {sip | analog} Enter the type of extension you configure. analog can only be configured on the 200D-T model. Add the user privilegefor the extension. user-privilege <name> class_of_ service_ default Fortinet Technologies Inc. Page 44 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 45: Log Setting Remote

    • smtp: Log SMTP relay or proxy events. • system: Log all system-related events, such as rebooting the FortiVoice unit. • voicemail: Log voicemail events. Enable or disable event logging. event-log-status {enable | disable disable} Fortinet Technologies Inc. Page 45 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 46 Enter the IP address of the Syslog server or FortiAnalyzer unit where the FortiVoice unit will store the logs. status {enable | disable} Enable or disable logging to the remote host. disable Fortinet Technologies Inc. Page 46 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 47: Log Setting Local

    • smtp: Log SMTP relay or proxy events. • system: Log all system-related events, such as rebooting the FortiVoice unit. • voicemail: Log voicemail events. event-log-status {enable | Enable or disable event logging. enable disable} Fortinet Technologies Inc. Page 47 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 48 (MB). The log file size limit must be between 10 MB and 1000 MB. status {enable | disable} Enable or disable logging to the local hard disk. enable Fortinet Technologies Inc. Page 48 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 49: Log Alertemail Recipient

    For more information, see “log alertemail setting” on page Syntax config log alertemail recipient edit <recipient_email> Variable Description Default <recipient_email> Type an email address that will receive alert email. Fortinet Technologies Inc. Page 49 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 50: Log Alertemail Setting

    <interval_int> Enter the size that the deferred email queue must reach to deferq-trigger 10000 cause an alert email to be sent. The valid range is 1 to 99999. <trigger_int> Fortinet Technologies Inc. Page 50 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 51: Mailsetting Relayserver

    SMTP relay if it supports SSL/TLS. When disabled, SMTP connections from the FortiVoice unit’s built-in MTA or proxy to the relay will occur as clear text, unencrypted. This option must be enabled to initiate SMTPS connections. Fortinet Technologies Inc. Page 51 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 52: Pbx Account-Code

    Syntax config pbx account-code edit <account_name> code <string> Variable Description Default <account_name> Enter a name for the account code. code <string> Enter the access code, such as 69. Fortinet Technologies Inc. Page 52 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 53: Pbx Call-Parking

    Enter a sound file for the call parking. parked-start <int> Enter the starting park orbit. parked-end <int> Enter the ending park orbit. timeout <int> Enter the time in seconds to time out the parked call. Fortinet Technologies Inc. Page 53 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 54: Pbx Feature-Access-Code

    Enable to allow entering further parameter for some disable disable} feature codes that require more values than codes only, such as pickup-ext. Without the parameters, these codes will not work. Fortinet Technologies Inc. Page 54 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 55: Pbx Location

    Enter the name displaying on the FortiVoice unit. This main-display-name name is provided by your PSTN service provider. main-number <string> Enter the main number of the FortiVoice unit. This number is provided by your PSTN service provider. Fortinet Technologies Inc. Page 55 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 56 Enter the name of the city where this FortiVoice unit locates. <string> Enter the name of the province where this FortiVoice pbx-address-province unit locates. <string> Enter the name of the street where this FortiVoice unit pbx-address-street <string> locates. Fortinet Technologies Inc. Page 56 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 57: Pbx Number-Management

    In the North American Numbering Plan calling area, you can use this pattern to match any long-distance number. 011. Matches any number that starts with 011 and has at least one more digit. Fortinet Technologies Inc. Page 57 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 58 3. This pattern will be followed when configuring speed dials. Enter the FortiVoice technical support extension. support-extension <string> Enter the allowed phone number prefix, such as 800. unrestricted-prefix 800 866 877 <string> Fortinet Technologies Inc. Page 58 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 59: Pbx Rating-Table

    Enter the ending time for the rate. other Enter the rate for other types of phone calls in cents. 0.000000 <currency_in_cents> Enter the trunk that will use the rates. trunk <name> Fortinet Technologies Inc. Page 59 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 60: Pbx Schedule

    Enter the PM end time for the week day, between 12:00 pm-end-time <hh:mm> 23:59 and 23:59. pm-start-time <hh:mm> Enter the PM start time for the week day, between 12: 17:01 00 and 23:59. Fortinet Technologies Inc. Page 60 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 61: Pbx Storage-Capacity

    MB. recording-file-retention Enter the number of days to keep the phone recording files. <int> Enter the maximum disk space allowed for voice voice-message-quota messages in MB. <string> Fortinet Technologies Inc. Page 61 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 62: Pbx System-Speed-Dial

    Enter a note for the mapping, such as “This is for customer A”. Enter the phone number to map to the speed dial code. number <string> For example, 222-1234. Fortinet Technologies Inc. Page 62 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 63: Pbx User-Privilege

    Enter the account code that needs to be dialed before exempt-account-code <name> making a long distance or international call. For information on account code, see pbx account- code. Enable or disable call restrictions. status {enable | disable} enable Fortinet Technologies Inc. Page 63 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 64 Enable or disable domestic long distance direct dialing. disable long-distance-call {enable | disable} paging-exempt <string> If you entered allow-all-with-exempt or disallow-all-with-exempt in paging-permission {allow-all | allow-all-with-exempt | disallow-all | disallow-all-with-exempt}, enter the exempted extension number. Fortinet Technologies Inc. Page 64 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 65 Enter the number of voice mails allowed. 1000 <int> voicemail-retention-days Enter the number of days to keep the voicemails. <int> voicemail-status {enable Enable or disable the voicemail service. enable | disable} Fortinet Technologies Inc. Page 65 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 66: Profile Caller-Id-Translate

    If you have entered a match-number <string>, enter a prefix <string> number before the extension. For example, if your match number is 8134 and prefix is 5, the caller ID will be 58134. Fortinet Technologies Inc. Page 66 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 67 0 means no action. For example, if your match number is 8134 and strip- digit is 2, only 81 will be displayed as caller ID. Fortinet Technologies Inc. Page 67 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 68: Profile Sip-Setting

    Codec will be used as long as it is one of your supported Codecs. Also configure codecs {g711u | g711a | g729 | g722 | g723.1 | g726 | gsm}. Fortinet Technologies Inc. Page 68 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 69 5061 is typically used for SIP sessions encrypted with Transport Layer Security (TLS). Enable the protocols as required. This option, if applied to a user, overrides the system- wide transport settings. Fortinet Technologies Inc. Page 69 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 70: Report

    Call_Usage_Summary | • Phone Bill: The cost of making the phone calls. Phone_Bill_Detailed | Phone_Bill_Summary | • Trunk Usage: The status of the trunks being used. Trunk_Usage_Detailed | Trunk_Usage_ Summary} Fortinet Technologies Inc. Page 70 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 71 Enter the call rate profile for the report. The rates apply to the calls in the report. rating-table. Enter the email addresses of the people who will recipients <email_addr> receive the report notifications. Separate the addresses with comma. Fortinet Technologies Inc. Page 71 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 72 {daily | dates | none | weekdays}, enter the hour for each day. If you enter weekdays in schedule {daily | dates | schedule-weekdays none | weekdays}, enter the day of the week. <weekday> Fortinet Technologies Inc. Page 72 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 73: Service Auto-Attendant

    Enter the key number that transfers a call to a resource, if pressed. This is to configure the auto attendant dial pad keys for callers to use when navigating through the auto attendant hierarchy. Fortinet Technologies Inc. Page 73 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 74 | dial-extension | dial-external-number | dial- operator | dial-ring-group | dial-voicemail | go-back | hang-up | lookup-name-directory | no-action | play- announcement | start-over}, enter the name of the sound file for the announcement. Fortinet Technologies Inc. Page 74 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 75 • dial-operator: The call is transferred to an operator. • start-over: The auto attendant will repeat the instructions for the caller. • hang-up: The call will be terminated. Fortinet Technologies Inc. Page 75 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 76: Service Conference

    Enter a password for joining the conference call. A 123456 caller needs to dial the conference call number and enter this password to join the conference call. Enter the user privilege for this conference call. user-privilege <name> Fortinet Technologies Inc. Page 76 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 77: Service Recording

    Enter the number pattern to match the callers’ phone numbers. <string> For information on pattern-matching syntax and pattern-matching examples, see “pbx number- management” on page status {enable | disable} Enable to activate this call recording. enable Fortinet Technologies Inc. Page 77 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 78: System Accprofile

    {none | read | read- For the rest of the configurations except monitor, enter none write} the permissions that will be granted to administrator accounts associated with this access profile. Fortinet Technologies Inc. Page 78 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 79: System Admin

    Failure to provide a strong password could compromise the security of your FortiVoice unit. Fortinet Technologies Inc. Page 79 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 80 FortiVoice unit. <host_ipv4mask> Separate each IP address and netmask pair with a comma ( , ). To allow the administrator to authenticate from any IP address, enter 0.0.0.0/0.0.0.0. Fortinet Technologies Inc. Page 80 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 81: System Appearance

    Extension. This hint will apear as a mouse-over <login_hint_str> display on the login name field of the user web portal. Select a theme for the user web portal GUI. webmail-theme RedGrey {IndigoDarkBlue | RedGrey | Standard} Fortinet Technologies Inc. Page 81 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 82: System Auto-Provisioning

    If you enter bind-to-interface for sip-server-option port2 | port3 | port4} {bind-to-interface | static-ip}, enter the interface for the server. The SIP phones connect to this server to register. Fortinet Technologies Inc. Page 82 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 83 PBX setup information. tftp-server-option {bind- Enter the option for the SIP phones to connect to the static-ip to-interface | static-ip} TFTP server to receive the PBX setup information. Fortinet Technologies Inc. Page 83 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 84: System Certificate Ca

    <name_str> certificate <cert_str> Variable Description Default Enter a name for this certificate. <name_str> Enter or paste the certificate in PEM format to import it. certificate <cert_str> Fortinet Technologies Inc. Page 84 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 85: System Certificate Crl

    <name_str> crl <cert_str> Variable Description Default Enter a name for this certificate revocation list. <name_str> Enter or paste the certificate in PEM format to import it. crl <cert_str> Fortinet Technologies Inc. Page 85 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 86: System Certificate Local

    Enter or paste the certificate signing request in PEM csr <csr_str> format to import it. password <pwd_str> Enter a password for the certificate. private-key <key_str> Enter a private key for the certificate. Fortinet Technologies Inc. Page 86 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 87: System Certificate Remote

    <name_str> certificate <cert_str> Variable Description Default Enter a name for the certificate to be imported. <name_str> Enter or paste the certificate in PEM format to import it. certificate <cert_str> Fortinet Technologies Inc. Page 87 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 88: System Ddns

    IP address to which will domain <domain_str> resolve. Also configure interface <interface_str>. static: Use the public IP address to which domain will resolve. Also configure <domain_str> <host_ipv4>. Fortinet Technologies Inc. Page 88 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 89 Enter the amount of time in hours after which your FortiVoice unit will contact the DDNS server to reaffirm its current IP address. Enter the user name of your account with the DDNS username <username_str> service provider. Fortinet Technologies Inc. Page 89 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 90: System Dhcp Server

    <name-str> interface <name_str> lease-time <int> match vci {enable | disable} netmask <ip> option1 <option_code> [<option_hex>] option2 <option_code> [<option_hex>] option3 <option_code> [<option_hex>] tftp-server <tftp_name/ip> status {enable | disable} vci-string <string> Fortinet Technologies Inc. Page 90 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 91 {default | specify}. dns-server2 <ip_addr> 0.0.0.0 Enter the IP address for the secondary DNS server. This option is available when you enter specify in dns- service {default | specify}. Fortinet Technologies Inc. Page 91 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 92 For more information, see “system auto-provisioning” on page status {enable | disable} enable Enable to activate the DHCP server. Enter the VCI name to match before serving a device. vci-string <string> Fortinet Technologies Inc. Page 92 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 93: System Dns

    IP addresses. Failure to contain records for those IP addresses may increase DNS query time and cause query results to be ‘Host not found’. secondary <dns_ipv4> Enter the IP address of the secondary DNS serve. 0.0.0.0 Fortinet Technologies Inc. Page 93 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 94: System Global

    Enter the SSH port number for administrative access on port-ssh <port_int> all interfaces. port-telnet <port_int> Enter the TELNET port number for administrative access on all interfaces. Fortinet Technologies Inc. Page 94 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 95: System Interface

    FortiVoice loopback interface’s IP address the same as the load balancer’s IP address and thus the FortiVoice unit can pick up the traffic forwarded to it from the load balancer. Fortinet Technologies Inc. Page 95 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 96 100half | 1000full speeds. |1000half} status {down | up} Enter either up to enable the network interface to send and receive traffic, or down to disable the network interface. Fortinet Technologies Inc. Page 96 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 97: System Mailserver

    The valid range is from 1 to 240 hours. Enter the number of minutes between delivery retries for queue-retry <interval_int> email messages in the deferred mail queues. The valid range is from 10 to 120 minutes. Fortinet Technologies Inc. Page 97 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 98: System Password-Policy

    • upper-case-letter — A, B, C, ... Z • lower-case-letter — a, b, c, ... z • number — 0, 1, 2, 3, 4, 5, 6, 7 8, 9 • non-alphanumeric — punctuation marks, @,#, ... Fortinet Technologies Inc. Page 98 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 99: System Port-Forwarding

    Enter the port number on the FortiVoice interface where port <port_number> the packets are received. protocol {tcp | udp | Specify the protocol of the traffic. both} Fortinet Technologies Inc. Page 99 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 100: System Route

    0.0.0.0 To indicate all traffic regardless of IP address and netmask, enter 0.0.0.0 0.0.0.0. gateway Enter the IP address of the gateway router. 0.0.0.0 <gateway_ipv4> Fortinet Technologies Inc. Page 100 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 101: System Sip-Setting

    If the unit is behind a firewall, these ports should be open. Ensure there is a reasonable port range so that you have enough ports for all open calls. Fortinet Technologies Inc. Page 101 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 102 <port_num> depending on your selection. If you entered udp in transport {tcp | tls | udp}, enter the udp-port <port_num> 5060 UDP port used for SIP. Fortinet Technologies Inc. Page 102 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 103: System Time Manual

    Enable to automatically adjust the system time for daylight-saving-time enable {disable | enable} daylight savings time (DST). zone <zone_int> Enter the number that indicates the time zone in which the FortiVoice unit is located. Fortinet Technologies Inc. Page 103 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 104: System Time Ntp

    Enter the interval in minutes between synchronizations of <interval_int> the system time with the NTP server. The valid range is from 1 to 1440 minutes. Fortinet Technologies Inc. Page 104 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 105: System Voicemail

    <int> max-greeting-seconds <int> Variable Description Default Enter the maximum message length in seconds. max-seconds-per- message <int> Enter the maximum greeting length in seconds. max-greeting-seconds <int> Fortinet Technologies Inc. Page 105 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 106: Trunk Office-Peer

    This option only works if the PBX of the remote office is a FortiVoice unit and sync-directory is enabled on the remote unit. Enter the trunk type. type {sip | iax2} Fortinet Technologies Inc. Page 106 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 107: Trunk Pstn

    These trunks can be analog or digital phone lines. This option is only available on the FortiVoice 200D-T model. The FortiVoice 200D-T supports four FXO (Foreign eXchange Office) analog ports and one FXS (Foreign eXchange Subscriber) digital port. There are two default PSTN/PRI trunks: •...
  • Page 108 FortiVoice unit supports T1/E1 lines according to the installed voice card. status {enable | disable} Enable to activate the analog trunk. enable type {analog | digital} Enter the trunk type. analog Fortinet Technologies Inc. Page 108 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 109: Trunk Sip-Peer

    FortiVoice unit. You can add multiple DIDs. Enter your caller ID that will appear on the phone of an caller-name <id_str> outbound call receiver. Fortinet Technologies Inc. Page 109 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 110 => user[:secret[: authuser]]@host [:port][/extension] register => fromuser@fromdomain: secret@host register => fromuser@fromdomain:secret: authuser@host:port/extension For example, a string could be: register => 2345: password@mysipprovider.com/1234 Fortinet Technologies Inc. Page 110 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 111 {enable | disable} Enable to activate the SIP trunk. enable username<name_str> Enter the user name provided by the provider for the FortiVoice unit to register with the SIP server. Fortinet Technologies Inc. Page 111 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 112: Voice Music-On-Hold

    If you want to play the sound files randomly, Enter sequential} Random. If you want to play the files according to the order of members <name_str> you entered, enter sequential. Fortinet Technologies Inc. Page 112 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 113: Voice Sound-File

    <int> Variable Description Default <name> Enter a name for the configuration. description <str> Enter a description for the sound file. language <int> Enter the number representing the language. Fortinet Technologies Inc. Page 113 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 114: Execute

    execute execute commands perform immediate operations on the FortiVoice unit. This chapter describes the following execute commands: backup restore config certificate restore image checklogdisk shutdown date smtptest storage factoryreset telnettest nslookup traceroute partitionlogdisk user-config phone user-config ping ping-option ping6 ping6-option reboot reload Page 114...
  • Page 115: Backup

    If you are adding a comment, do not add spaces, [<comments_str>] underscore characters ( _ ), or quotation marks ( “ ) or any other punctuation marks. Fortinet Technologies Inc. Page 115 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 116: Certificate

    TFTP server. <cert_name> <file_name> <tftp_ip> Note that this command does not support exporting a certificate in PKCS#12 format. To do this, you must go to the web UI. Fortinet Technologies Inc. Page 116 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 117 OCSP enables you to revoke or validate certificates by query, rather than by importing certificate revocation lists (CRL). remote export tftp Exports the OCSP certificate to a TFTP server. <cert_name> <file_name> <tftp_ip> Fortinet Technologies Inc. Page 117 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 118: Checklogdisk

    Use this command to find and correct errors on the log disk. Use this command only when recommended by Fortinet Technical Support. Logging is suspended while this command is executing. Syntax execute checklogdisk Fortinet Technologies Inc. Page 118 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 119: Date

    Use this command to set the system date. Syntax execute date <date_str> Variable Description Default <date_str> Enter the system date in the format of mm/dd/yyyy. Fortinet Technologies Inc. Page 119 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 120 Try to repair all of the databases using force recovery. force-recover Clean and rebuild all of the databases. rebuild Enter the name of the database to clean and rebuild. reset <database> Fortinet Technologies Inc. Page 120 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 121: Dhcp Lease-Clear

    Use this command to clear all DHCP address leases. Syntax For IPv4: execute dhcp lease-clear For IPv6: execute dhcp6 lease-clear Fortinet Technologies Inc. Page 121 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 122: Dhcp Lease-List

    Otherwise, the list includes all leases issued by DHCP servers on the FortiVoice unit. If there are no DHCP leases in use on the FortiVocie unit, an error will be returned. Fortinet Technologies Inc. Page 122 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 123: Factoryreset

    IP addresses of network interfaces. For information on creating a backup, see the FortiVoice Setup and Administration Guide. Syntax execute factoryreset Fortinet Technologies Inc. Page 123 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 124: Nslookup

    IP address. If you do not specify the server here, FortiMail will use its local host DNS settings. <port_number>: optionally specify the port number of the DNS server. Fortinet Technologies Inc. Page 124 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 125: Partitionlogdisk

    <logpercentage_str> total hard disk space. The remaining partition (by default, 75% of the hard disk space) will be used for voice data. Fortinet Technologies Inc. Page 125 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 126: Phone

    <logpercentage_str> Variable Description Default reboot <extension_num_str> Enter the extensions to be rebooted. cfg-all {generate | delete} Enter generate to refresh the files and delete to remove the files. Fortinet Technologies Inc. Page 126 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 127: Ping

    Pings are often used to test connectivity. Syntax execute ping {<fqdn_str> | <host_ipv4>} Variable Description Default Enter either the IP address or fully qualified ping {<fqdn_str> | <host_ipv4>} domain name (FQDN) of the host. Fortinet Technologies Inc. Page 127 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 128: Ping-Option

    • throughput: Maximize throughput. Enter the time-to-live (TTL) value. ttl <hops_int> Select whether or not to validate ping replies. validate-reply {yes | no} Display the current ping option settings. view-settings Fortinet Technologies Inc. Page 128 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 129: Ping6

    Pings are often used to test connectivity. Syntax execute ping6 {<fqdn_str> | <host_ipv4>} Variable Description Default ping6 {<fqdn_str> | <host_ipv4>} Enter either the IP address or fully qualified domain name (FQDN) of the host. Fortinet Technologies Inc. Page 129 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 130: Ping6-Option

    • throughput: Maximize throughput. Enter the time-to-live (TTL) value. ttl <hops_int> Select whether or not to validate ping replies. validate-reply {yes | no} Display the current ping option settings. view-settings Fortinet Technologies Inc. Page 130 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 131: Reboot

    FortiVoice unit. Syntax execute reboot Fortinet Technologies Inc. Page 131 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 132: Reload

    If the command does not take a few seconds to execute, it is possible that the daemon does not really exist. Syntax execute reload [<daemon_name>] Fortinet Technologies Inc. Page 132 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 133: Restore Config

    • template: Apply a template revision number. <revision_int> If you want to restore a configuration file or apply a template stored on a FortiManager unit, enter the revision number of the configuration file or template. Fortinet Technologies Inc. Page 133 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 134: Restore Image

    <image_id> If you want to restore a firmware file stored on a FortiManager unit, enter the management-station keyword then enter the ID number of the firmware file. Fortinet Technologies Inc. Page 134 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 135: Shutdown

    Power off the FortiVoice unit only after issuing this command. Unplugging or switching off the FortiVoice unit without issuing this command could result in data loss. Syntax execute shutdown Fortinet Technologies Inc. Page 135 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 136: Smtptest

    25, enter a colon (:) followed by the port number. If you want to test the connection from an IP [domain <domain_str>] address in the protected domain’s IP pool, enter default. the name of the protected domain. Fortinet Technologies Inc. Page 136 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 137: Storage

    Remove all data on the remote storage device. format Check the remote file storage system. fscheck Start the remote storage daemon. start Test the remote file storage system. test Fortinet Technologies Inc. Page 137 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 138: Telnettest

    (FQDN) of the Telnet server. default. [:<port_int>] If the Telnet server listens on a port number other than port 23, enter a colon (:) followed by the port number. Fortinet Technologies Inc. Page 138 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 139: Traceroute

    FortiVoice unit. Syntax execute traceroute {<fqdn_str> | <host_ipv4>} Variable Description Default traceroute {<fqdn_str> | Enter the IP address or fully qualified domain <host_ipv4>} name (FQDN) of the host. Fortinet Technologies Inc. Page 139 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 140: User-Config

    Variable Description Default generate Updates the user configuration file with the latest user-specific configuration. Displays the timestamp when the last configuration getinfo file update was performed. Fortinet Technologies Inc. Page 140 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 141: Get

    If you were to now enter end, saving your setting to disk, get output for both syntactical forms would again match. However, if you were to enter abort at this point and discard your recently Fortinet Technologies Inc. Page 141 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 142 For syntax examples and descriptions of each configuration object, field, and option, see “config” on page Fortinet Technologies Inc. Page 142 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 143: System Performance

    Displays the FortiVoice unit’s CPU usage, memory usage, system load, and up time. Syntax get system performance Fortinet Technologies Inc. Page 143 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 144: System Status

    • FortiVoice unit serial number and BIOS version • log hard disk availability • host name • branching point (same as firmware build number) • release version • system time Syntax get system status Fortinet Technologies Inc. Page 144 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 145: Show & Show Full-Configuration

    Depending on whether or not you have specified an object, like get, show may display one of two different outputs: either the configuration that you have just entered but not yet saved, or the configuration as it currently exists on the disk, respectively. Fortinet Technologies Inc. Page 145 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 146 If you have entered settings but cannot remember how they differ from the existing configuration, the two different forms of show, with and without the object name, can be a useful way to remind yourself. Fortinet Technologies Inc. Page 146 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 147: Index

    123, 133, 134 International characters 20 DB-9 6 _ipv4 13 default _ipv4/mask 13 administrator account 7 password 7 _ipv4mask 13 definitions 11 _ipv4range 13 delete, shell command 15 _ipv6 13 Fortinet Technologies Inc. Page 147 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 148 70 unknown action 11 unset 17 up time 143 regular expression 13 _url 13 rename, shell command 16 US-ASCII 20 using the CLI 6 UTF-8 20 _v4mask 13 Fortinet Technologies Inc. Page 148 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...
  • Page 149 _v6mask 13 value 12 web-based manager value parse error 12, 13 language 81 wild cards 13 Fortinet Technologies Inc. Page 149 FortiVoice 200D/200D-T v2.0 MR1 CLI Reference...

This manual is also suitable for:

Fortivoice 200d-t

Table of Contents