Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.0.0
Download PDF
Copy Link

pbx

Use this command to view active channels and to delete, list or upload music files for when music is playing while a caller is on hold.

Syntax

execute pbx active-call <list>

execute pbx extension <list>

execute pbx ftgd-voice-pkg {sip‑trunk}

execute pbx music-on-hold {delete | list | upload}

execute pbx prompt upload ftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

execute pbx prompt upload tftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

execute pbx prompt upload usb <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

execute pbx restore-default-prompts

execute pbx sip-trunk list

Variables Description

active-call <list>

Enter to display a list of the active calls being processed by the FortiGate Voice unit.

extension <list>

Enter to display the status of all extensions with SIP phones that have connected to the FortiGate Voice unit.

ftgd-voice-pkg {sip‑trunk}

Enter to retrieve FortiGuard voice package sip trunk information.

music-on-hold {delete | list | upload}

Enter to either delete, list or upload music on hold files. You can upload music on hold files using FTP, TFTP, or from a USB drive plugged into the FortiGate Voice unit.

prompt upload ftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

Upload new pbx voice prompt files using FTP. The voice prompt files should be added to a tar file and zipped. This file would usually have the extension tgz. You must include the filename, FTP server address (domain name of IPv4 address) and if required the username and password for the server.

prompt upload tftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

Upload new pbx voice prompt files using TFTP. The voice prompt files should be added to a tar file and zipped. This file would usually have the extension tgz. You must include the filename and TFTP server IP address.

prompt upload usb <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

Upload new pbx voice prompt files from a USB drive plugged into the FortiGate Voice unit. The voice prompt files should be added to a tar file and zipped. This file would usually have the extension tgz. You must include the filename.

restore-default-prompts

Restore default English voicemail and other PBX system prompts. Use this command if you have changed the default prompts and want to restore the default settings.

sip-trunk list

Enter to display the status of all SIP trunks that have been added to the FortiGate Voice configuration.

Example command output

Enter the following command to view active calls:

execute pbx active-call

 

Call-From    Call-To    Durationed

6016         6006       00:00:46

Enter the following command to display the status of all extensions

execute pbx extension list

Extension Host Dialplan

6052 Unregister company-default

6051 Unregister company-default

6050 Unregister company-default

6022 Unregister company-default

6021/6021 172.30.63.34 company-default

6020 Unregister company-default

Enter the following command to display the status of all SIP trunks

execute pbx sip-trunk list

Name        Host          Username     Account-Type    State

Provider_1  192.169.20.1  +5555555     Static           N/A

pbx

Use this command to view active channels and to delete, list or upload music files for when music is playing while a caller is on hold.

Syntax

execute pbx active-call <list>

execute pbx extension <list>

execute pbx ftgd-voice-pkg {sip‑trunk}

execute pbx music-on-hold {delete | list | upload}

execute pbx prompt upload ftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

execute pbx prompt upload tftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

execute pbx prompt upload usb <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

execute pbx restore-default-prompts

execute pbx sip-trunk list

Variables Description

active-call <list>

Enter to display a list of the active calls being processed by the FortiGate Voice unit.

extension <list>

Enter to display the status of all extensions with SIP phones that have connected to the FortiGate Voice unit.

ftgd-voice-pkg {sip‑trunk}

Enter to retrieve FortiGuard voice package sip trunk information.

music-on-hold {delete | list | upload}

Enter to either delete, list or upload music on hold files. You can upload music on hold files using FTP, TFTP, or from a USB drive plugged into the FortiGate Voice unit.

prompt upload ftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

Upload new pbx voice prompt files using FTP. The voice prompt files should be added to a tar file and zipped. This file would usually have the extension tgz. You must include the filename, FTP server address (domain name of IPv4 address) and if required the username and password for the server.

prompt upload tftp <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

Upload new pbx voice prompt files using TFTP. The voice prompt files should be added to a tar file and zipped. This file would usually have the extension tgz. You must include the filename and TFTP server IP address.

prompt upload usb <file.tgz> <ftp_server_address>[:port] [<username>] [password>]

Upload new pbx voice prompt files from a USB drive plugged into the FortiGate Voice unit. The voice prompt files should be added to a tar file and zipped. This file would usually have the extension tgz. You must include the filename.

restore-default-prompts

Restore default English voicemail and other PBX system prompts. Use this command if you have changed the default prompts and want to restore the default settings.

sip-trunk list

Enter to display the status of all SIP trunks that have been added to the FortiGate Voice configuration.

Example command output

Enter the following command to view active calls:

execute pbx active-call

 

Call-From    Call-To    Durationed

6016         6006       00:00:46

Enter the following command to display the status of all extensions

execute pbx extension list

Extension Host Dialplan

6052 Unregister company-default

6051 Unregister company-default

6050 Unregister company-default

6022 Unregister company-default

6021/6021 172.30.63.34 company-default

6020 Unregister company-default

Enter the following command to display the status of all SIP trunks

execute pbx sip-trunk list

Name        Host          Username     Account-Type    State

Provider_1  192.169.20.1  +5555555     Static           N/A