add administrator

Description

Adds a new user who can access the administration web portal and SSH.

Syntax

add administrator username <username> [ password-hash <password-hash> ] permission <permission>

Parameters

Example

add administrator username admin password-hash TZXPLs20bN0RA permission read-write

Output

Failure shows an appropriate error message.

delete administrator

Description

Deletes an existing defined administrator. The system will not allow deletion of the last administrator.

Syntax

delete administrator username <username>

Parameters

Example

delete administrator username admin

Output

Failure shows an appropriate error message.

set administrator

Configures an existing user with administrator privileges.

set administrator

Description

Configures a new password for an existing administrator. You will be prompted to add a new password following this command (this command cannot be used in a script).

Syntax

set administrator username <username> password

Parameters

Example

set administrator username admin password

Output

Failure shows an appropriate error message.

set administrator

Description

Configures an existing administrator’s permission level and password (by hash).

Syntax

set administrator username <username> permission <permission> [ password-hash <password-hash> ]

Parameters

Example

set administrator username admin permission read-write password-hash TZXPLs20bN0RA

Output

Failure shows an appropriate error message.

set administrators

Configure users with administrator privileges through a RADIUS server.

set administrators

Description

Configures users with administrator privileges through a RADIUS server.

Syntax

set administrators radius-auth { true [ use-radius-groups { true

radius-groups <radius-groups> | false } ] [ permission <permission> ] | false

}

Parameters

Example

set administrators radius-auth true use-radius-groups true radius-groups My group permission read-write

Output

Failure shows an appropriate error message.

show administrator

Description

Shows settings of an existing user with administrator privileges.

Syntax

show administrator username <username>

Parameters

Example

show administrator username admin

Output

Failure shows an appropriate error message.

show administrators

Shows settings of all users with administrator privileges.

show administrators

Description

Shows settings of all users with administrator privileges.

Syntax

show administrators

Parameters

Example

show administrators

Output

Failure shows an appropriate error message.

show administrators

Description

Shows advanced settings of all users with administrator privileges.

Syntax

show administrators advanced-settings

Parameters

Example

show administrators advanced-settings

Output

Failure shows an appropriate error message.

administrators radius-auth

show administrators radius-auth

Description

Shows RADIUS related settings for users with administrator privileges.

Syntax

show administrators radius-auth

Parameters

Example

show administrators radius-auth

Output

Failure shows an appropriate error message.

administrator session-settings

set administrator session-settings

Description

Configures session settings for administrators. The settings are global for all administrators.

Syntax

set administrator session-settings [ lockout-enable <lockout-enable> ] [ max-lockout-attempts <max-lockout-attempts> ] [ lock-period <lock-period>

] [ inactivity-timeout <inactivity-timeout> ] [ password-complexity-level

<password-complexity-level> ] [ password-expiration-timeout

<password-expiration-timeout> ]

Parameters

Example

set administrator session-settings lockout-enable on max-lockout-attempts

5 lock-period 5 inactivity-timeout 5 password-complexity-level

low password-expiration-timeout 5

Output

Failure shows an appropriate error message.

show administrator session-settings

Description

Shows session settings for users with administrator privileges.

Syntax

show administrator session-settings

Parameters

Example

show administrator session-settings

Output

Failure shows an appropriate error message.

show adsl statistics

Description

Shows statistics regarding the DSL internet connection (applicable on appliance models with DSL).

Syntax

show adsl statistics

Parameters

Example

show adsl statistics

Output

Failure shows an appropriate error message.

aggressive-aging

set aggressive-aging

Configures aggressive aging feature’s behavior. Aggressive Aging is designed to optimize how the device is dealing with a large connection number by aggressively reducing the timeout of existing connections when necessary.

set aggressive-aging

Description

Configures aggressive aging default reduced timeouts.

Syntax

set aggressive-aging [ icmp-timeout <icmp-timeout> ] [ icmp-timeout-enable

<icmp-timeout-enable> ] [ other-timeout <other-timeout> ] [ other-timeout-enable <other-timeout-enable> ] [ pending-timeout

<pending-timeout> ] [ pending-timeout-enable <pending-timeout-enable>

] [ tcp-end-timeout <tcp-end-timeout> ] [ tcp-end-timeout-enable

<tcp-end-timeout-enable> ] [ tcp-start-timeout <tcp-start-timeout> ] [ tcp-start-timeout-enable <tcp-start-timeout-enable> ] [ tcp-timeout

<tcp-timeout> ] [ tcp-timeout-enable <tcp-timeout-enable> ] [

udp-timeout <udp-timeout> ] [ udp-timeout-enable <udp-timeout-enable>

] [ general <general> ] [ log <log> ] [ connt-limit-high-watermark-pct

<connt-limit-high-watermark-pct> ] [ connt-mem-high-watermark-pct

<connt-mem-high-watermark-pct> ] [ memory-conn-status <memory-conn-status> ]

Parameters

Example

set aggressive-aging icmp-timeout 30 icmp-timeout-enable true other-timeout 30 other-timeout-enable true pending-timeout 30 pending-timeout-enable true tcp-end-timeout 3600 tcp-end-timeout-enable true tcp-start-timeout 3600 tcp-start-timeout-enable true tcp-timeout

3600 tcp-timeout-enable true udp-timeout 3600 udp-timeout-enable true general true log log connt-limit-high-watermark-pct 80

connt-mem-high-watermark-pct 80 memory-conn-status both

Output

Failure shows an appropriate error message.

set aggressive-aging

Description

Configures aggressive aging advanced settings.

Syntax

set aggressive-aging advanced-settings connections [ other-timeout-enable

<other-timeout-enable> ] [ connt-limit-high-watermark-pct <connt-limit-high-watermark-pct>

] [ tcp-start-timeout-enable <tcp-start-timeout-enable> ] [ icmp-timeout-enable <icmp-timeout-enable> ] [ general <general>

] [ tcp-timeout-enable <tcp-timeout-enable> ] [ tcp-timeout

<tcp-timeout> ] [ tcp-start-timeout <tcp-start-timeout> ] [

udp-timeout-enable <udp-timeout-enable> ] [ udp-timeout <udp-timeout>

] [ pending-timeout-enable <pending-timeout-enable> ] [ log <log>

] [ connt-mem-high-watermark-pct <connt-mem-high-watermark-pct> ] [ tcp-end-timeout-enable <tcp-end-timeout-enable> ] [ icmp-timeout

<icmp-timeout> ] [ tcp-end-timeout <tcp-end-timeout> ] [ memory-conn-status

<memory-conn-status> ] [ pending-timeout <pending-timeout> ] [ other-timeout

<other-timeout> ]

Parameters

Example

set aggressive-aging advanced-settings connections other-timeout-enable true connt-limit-high-watermark-pct -1000000 tcp-start-timeout-enable true icmp-timeout-enable true general true tcp-timeout-enable true tcp-timeout

-1000000 tcp-start-timeout -1000000 udp-timeout-enable true udp-timeout

-1000000 pending-timeout-enable true log log connt-mem-high-watermark-pct

-1000000 tcp-end-timeout-enable true icmp-timeout -1000000 tcp-end-timeout

-1000000 memory-conn-status both pending-timeout -1000000 other-timeout

-1000000

Output

Failure shows an appropriate error message.

show aggressive-aging

Shows aggressive aging settings.

show aggressive-aging

Description

Shows aggressive aging settings.

Syntax

show aggressive-aging

Parameters

Example

show aggressive-aging

Output

Failure shows an appropriate error message.

show aggressive-aging

Description

Shows aggressive aging advanced settings.

Syntax

show aggressive-aging advanced-settings

Parameters

Example

show aggressive-aging advanced-settings

Output

Failure shows an appropriate error message.

antispam

set antispam

Configures policy for Anti-Spam blade.

set antispam

Description

Configures the policy for Anti-Spam blade.

Syntax

set antispam [ mode <mode> ] [ detection-method <detection-method> ] [ log <log> ] [ action-spam-email-content <action-spam-email-content> ] [ flag-subject-stamp <flag-subject-stamp> ] [ detect-mode <detect-mode>

] [ specify-suspected-spam-settings { true [ suspected-spam-log

<suspected-spam-log> ] [ action-suspected-spam-email-content

<action-suspected-spam-email-content> ] [ flag-suspected-spam-subject-stamp

<flag-suspected-spam-subject-stamp> ] | false } ]

Parameters

Example

set antispam mode on detection-method email-content log none

action-spam-email-content block flag-subject-stamp several words detect-mode true specify-suspected-spam-settings true suspected-spam-log none

action-suspected-spam-email-content block flag-suspected-spam-subject-stamp several words

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings ip-rep-fail-open <ip-rep-fail-open>

Parameters

Example

set antispam advanced-settings ip-rep-fail-open true

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings email-size-scan <email-size-scan>

Parameters

Example

set antispam advanced-settings email-size-scan 1024

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings scan-outgoing <scan-outgoing>

Parameters

Example

set antispam advanced-settings scan-outgoing true

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings spam-engine-timeout <spam-engine-timeout>

Parameters

Example

set antispam advanced-settings spam-engine-timeout 15

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings allow-mail-track <allow-mail-track>

Parameters

Example

set antispam advanced-settings allow-mail-track none

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings transparent-proxy <transparent-proxy>

Parameters

Example

text

set antispam advanced-settings transparent-proxy true

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings ip-rep-timeout <ip-rep-timeout>

Parameters

Example

set antispam advanced-settings ip-rep-timeout 15

Output

Failure shows an appropriate error message.

set antispam

Description

Configures advanced setting for the Anti-Spam blade.

Syntax

set antispam advanced-settings spam-engine-all-mail-track

<spam-engine-all-mail-track>

Parameters

Example

set antispam advanced-settings spam-engine-all-mail-track none

Output

Failure shows an appropriate error message.

show antispam

Shows the configured policy for the Anti-Spam blade.

show antispam

Description

Shows the configured policy for the Anti-Spam blade.

Syntax

show antispam

Parameters

Example

show antispam

Output

Failure shows an appropriate error message.

show antispam

Description

Shows the advanced settings in the configured policy for the Anti-Spam blade.

Syntax

show antispam advanced-settings

Parameters

Example

show antispam advanced-settings

Output

Failure shows an appropriate error message.

antispam allowed-sender

add antispam allowed-sender

Adds a new Anti-Spam "allow" exception.

add antispam allowed-sender

Description

Adds a new Anti-Spam "allow" exception for a specific IP address.

Syntax

add antispam allowed-sender ipv4-addr <ipv4-addr>

Parameters

Example

add antispam allowed-sender ipv4-addr 192.168.1.1

Output

Failure shows an appropriate error message.

add antispam allowed-sender

Description

Adds a new Anti-Spam "allow" exception for a sender email or domain.

Syntax

add antispam allowed-sender sender-or-domain <sender-or-domain>

Parameters

Example

text

add antispam allowed-sender sender-or-domain myEmail@mail.com

Output

Failure shows an appropriate error message.

delete antispam allowed-sender

Deletes an existing Anti-Spam “allow” exception.

delete antispam allowed-sender

Description

Deletes all existing Anti-Spam “allow” exceptions.

Syntax

delete antispam allowed-sender all

Parameters

Example

delete antispam allowed-sender all

Output

Failure shows an appropriate error message.

delete antispam allowed-sender

Description

Deletes an existing Anti-Spam “allow” exception for sender’s email or domain.

Syntax

delete antispam allowed-sender sender-or-domain <sender-or-domain>

Parameters

Example

delete antispam allowed-sender sender-or-domain myEmail@mail.com

Output

Failure shows an appropriate error message.

delete antispam allowed-sender

Description

Deletes an existing Anti-Spam “allow” exception for a specific IPv4 address.

Syntax

delete antispam allowed-sender ipv4-addr <ipv4-addr>

Parameters

Example

delete antispam allowed-sender ipv4-addr 192.168.1.1

Output

Failure shows an appropriate error message.

show antispam allowed-senders

Description

Shows the “allowed” exceptions for the Anti-Spam blade.

Syntax

show antispam allowed-senders

Parameters

Example

show antispam allowed-senders

Output

Failure shows an appropriate error message.

antispam blocked-sender

add antispam blocked-sender

Adds a new Anti-Spam "block" exception.

add antispam blocked-sender

Description

Adds a new Anti-Spam "block" exception for a specific IP address.

Syntax

add antispam blocked-sender ipv4-addr <ipv4-addr>

Parameters

Example

add antispam blocked-sender ipv4-addr 192.168.1.1

Output

Failure shows an appropriate error message.

add antispam blocked-sender

Description

Adds a new Anti-Spam "block" exception for a sender email or domain.

Syntax

add antispam blocked-sender sender-or-domain <sender-or-domain>

Parameters

Example

add antispam blocked-sender sender-or-domain myEmail@mail.com

Output

Failure shows an appropriate error message.

delete antispam blocked-sender

Deletes an existing Anti-Spam "block" exception.

delete antispam blocked-sender

Description

Deletes all existing Anti-Spam “block” exceptions.

Syntax

delete antispam blocked-sender all

Parameters

Example

delete antispam blocked-sender all

Output

Failure shows an appropriate error message.

delete antispam blocked-sender

Description

Deletes an existing Anti-Spam “block” exception for sender’s email or domain.

Syntax

delete antispam blocked-sender sender-or-domain <sender-or-domain>

Parameters

Example

delete antispam blocked-sender sender-or-domain myEmail@mail.com

Output

Failure shows an appropriate error message.

delete antispam blocked-sender

Description

Deletes an existing Anti-Spam “block” exception for a specific IPv4 address.

Syntax

delete antispam blocked-sender ipv4-addr <ipv4-addr>

Parameters

Example

delete antispam blocked-sender ipv4-addr 192.168.1.1

Output

Failure shows an appropriate error message.

show antispam blocked-senders

Description

Shows the “blocked” exceptions for the Anti-Spam blade.

Syntax

show antispam blocked-senders

Parameters

Example

show antispam blocked-senders

Output

Failure shows an appropriate error message.

application

add application

Adds a new custom application object (string or regular expression signature over URL).

add application

Description

Adds a new custom application object (string or regular expression signature over URL).

Syntax

add application application-name <application-name> category <category> [ regex-url <regex-url> ] application-url <application-url>

Parameters

Example

add application application-name http://somehost.example.com category TEXT regex-url true application-url http://somehost.example.com

Output

Failure shows an appropriate error message.

add application

Description

Simplified method for adding a new custom application object (string over URL)

Syntax

add application-url <application-url>

Parameters

Example

add application-url http://somehost.example.com

Output

Failure shows an appropriate error message.

delete application

Deletes an existing custom application object (string or regular expression signature over URL).

delete application

Description

Deletes an existing custom application object by application ID.

Syntax

delete application application-id <application-id>

Parameters

Example

delete application application-id 1000000

Output

Failure shows an appropriate error message.

delete application

Description

Deletes an existing custom application object by application name.

Syntax

delete application application-name <application-name>

Parameters

Example

delete application application-name http://somehost.example.com

Output

Failure shows an appropriate error message.

find application

Description

Find an application by name (or partial string) to view further details regarding it.

Syntax

find application <application-name>

Parameters

Example

find application TEXT

Output

Failure shows an appropriate error message.

set application

Configures an existing custom application object.

set application

Description

Adds a URL to an existing custom application object by name.

Syntax

set application application-name <application-name> add url <url>

Parameters

Example

set application application-name http://somehost.example.com add url http://somehost.example.com

Output

Failure shows an appropriate error message.

set application

Description

Removes a URL from an existing custom application object by name.

Syntax

set application application-name <application-name> remove url <url>

Parameters

Example

set application application-name http://somehost.example.com remove url http://somehost.example.com

Output

Failure shows an appropriate error message.

set application

Description

Adds a URL to an existing custom application object by ID.

Syntax

set application application-id <application-id> add url <url>

Parameters

Example

set application application-id 12345678 add url http://somehost.example.com

Output

Failure shows an appropriate error message.

set application

Description

Removes a URL from an existing custom application object by ID.

Syntax

set application application-id <application-id> remove url <url>

Parameters

Example

set application application-id 12345678 remove url http://somehost.example.com

Output

Failure shows an appropriate error message.

set application

Description

Adds a category to an existing custom application object by name.

Syntax

set application application-name <application-name> add category <category>

Parameters

Example

set application application-name http://somehost.example.com add category TEXT

Output

Failure shows an appropriate error message.

set application

Description

Removes a category from an existing custom application object by name.

Syntax

set application application-name <application-name> remove category <category>

Parameters

Example

set application application-name http://somehost.example.com remove category TEXT

Output

Failure shows an appropriate error message.

set application

Description

Adds a category to an existing custom application object by ID.

Syntax

set application application-id <application-id> add category <category>

Parameters

Example

set application application-id 12345678 add category TEXT

Output

Failure shows an appropriate error message.

set application

Description

Removes a category from an existing custom application object by ID.

Syntax

set application application-id <application-id> remove category <category>

Parameters

Example

set application application-id 12345678 remove category TEXT

Output

Failure shows an appropriate error message.

set application

Description

Configures an existing custom application by ID.

Syntax

set application application-id <application-id> [ category <category> ] [ regex-url <regex-url> ]

Parameters

Example

set application application-id 12345678 category TEXT regex-url true

Output

Failure shows an appropriate error message.

set application

Description

Configures an existing custom application by name.

Syntax

set application application-name <application-name> [ category <category> ] [ regex-url <regex-url> ]

Parameters

Example

set application application-name http://somehost.example.com category TEXT regex-url true

Output

Failure shows an appropriate error message.

show application

Shows details for a specific application in the Application Control database.

show application

Description

Shows details for a specific application in the Application Control database by application name.

Syntax

show application application-name <application-name>

Parameters

Example

show application application-name TEXT

Output

Failure shows an appropriate error message.

show application

Description

Shows details for a specific application in the Application Control database by application ID.

Syntax

show application application-id <application-id>

Parameters

Example

show application application-id 12345678

Output

Failure shows an appropriate error message.

show applications

Description

Shows details of all applications.

Syntax

show applications

Parameters

Example

show applications

Output

Failure shows an appropriate error message.

application-control

set application-control

Description

Configures the default policy for the Application Control and URL filtering blades.

Syntax

set application-control [ mode <mode> ] [ url-flitering-only

<url-flitering-only> ] [ block-security-categories <block-security-categories> ] [ block-inappropriate-content <block-inappropriate-content> ] [ block-other-undesired-applications <block-other-undesired-applications> ] [ block-file-sharing-applications <block-file-sharing-applications> ] [ limit-bandwidth { true [ limit-upload { true set-limit <set-limit> | false } ] [ limit-download { true set-limit <set-limit> | false } ] | false } ]

Parameters

Example

set application-control mode true url-flitering-only true block-security-categories true block-inappropriate-content true

block-other-undesired-applications true block-file-sharing-applications true limit-bandwidth true limit-upload true set-limit 5 limit-download true set-limit 100

Output

Failure shows an appropriate error message.

show application-control

Description

Shows the configured policy for the Application Control blade

Syntax

show application-control

Parameters

Example

show application-control

Output

Failure shows an appropriate error message.

show application-control other-undesired-applications

Description

Shows the content of the custom “Other Undesired Applications” group. This group can be chosen to be blocked by default by the Application Control policy.

Syntax

show application-control other-undesired-applications

Parameters

Example

show application-control other-undesired-applications

Output

Failure shows an appropriate error message.

application-control-engine-settings

set application-control-engine-settings

Configures Application Control blade’s advanced engine settings.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings fail-mode <fail-mode>

Parameters

Example

set application-control-engine-settings advanced-settings fail-mode allow-all-requests

Output

Failure shows an appropriate error message.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings

block-requests-when-web-service-unavailable <block-requests-when-web-service-unavailable>

Parameters

Example

set application-control-engine-settings advanced-settings block-requests-when-web-service-unavailable true

Output

Failure shows an appropriate error message.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings enforce-safe-search <enforce-safe-search>

Parameters

Example

set application-control-engine-settings advanced-settings enforce-safe-search true

Output

Failure shows an appropriate error message.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings web-site-categorization-mode <web-site-categorization-mode>

Parameters

Example

set application-control-engine-settings advanced-settings web-site-categorization-mode background

Output

Failure shows an appropriate error message.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings track-browse-time

<track-browse-time>

Parameters

Example

set application-control-engine-settings advanced-settings track-browse-time true

Output

Failure shows an appropriate error message.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings http-referrer-identification <http-referrer-identification>

Parameters

Example

set application-control-engine-settings advanced-settings http-referrer-identification true

Output

Failure shows an appropriate error message.

set application-control-engine-settings

Description

Configures Application Control blade’s advanced engine settings.

Syntax

set application-control-engine-settings advanced-settings

categorize-cached-and-translated-pages <categorize-cached-and-translated-pages>

Parameters

Example

set application-control-engine-settings advanced-settings categorize-cached-and-translated-pages true

Output

Failure shows an appropriate error message.

show application-control-engine-settings

Description

Shows advanced settings of the Application Control blade.

Syntax

show application-control-engine-settings advanced-settings

Parameters

Example

show application-control-engine-settings advanced-settings

Output

Failure shows an appropriate error message.

application-group

add application-group

Description

Adds a new group object for applications.

Syntax

add application-group name <name>

Parameters

Example

add application-group name users

Output

Failure shows an appropriate error message.

delete application-group

Deletes an existing group object of applications.

delete application-group

Description

Deletes an existing group object of applications by group object name.

Syntax

delete application-group name <name>

Parameters

Example

delete application-group name users

Output

Failure shows an appropriate error message.

delete application-group

Description

Deletes an existing group object of applications by group object ID.

Syntax

delete application-group application-group-id <application-group-id>

Parameters

Example

delete application-group application-group-id 12345678

Output

Failure shows an appropriate error message.

set application-group

Configures an existing application group object.

set application-group

Description

Adds an application to an existing application group object by application’s name.

Syntax

set application-group name <name> add application-name <application-name>

Parameters

Example

set application-group name users add application-name hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Removes an application from an existing application group object by application’s name.

Syntax

set application-group name <name> remove application-name <application-name>

Parameters

Example

set application-group name users remove application-name hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Adds an application to an existing application group object by application’s ID.

Syntax

set application-group name <name> add application-id <application-id>

Parameters

Example

set application-group name users add application-id hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Removes an application from an existing application group object by application’s ID.

Syntax

set application-group name <name> remove application-id <application-id>

Parameters

Example

set application-group name users remove application-id hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Adds an application to an existing application group object by application’s name using group object’s ID.

Syntax

set application-group application-group-id <application-group-id> add application-name <application-name>

Parameters

Example

set application-group application-group-id 12345678 add application-name hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Removes an application from an existing application group object by application’s name using group object’s ID.

Syntax

set application-group application-group-id <application-group-id> remove application-name <application-name>

Parameters

Example

set application-group application-group-id 12345678 remove application-name hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Adds an application to an existing application group object by application’s ID using group object’s ID.

Syntax

set application-group application-group-id <application-group-id> add application-id <application-id>

Parameters

Example

set application-group application-group-id 12345678 add application-id hasMany

Output

Failure shows an appropriate error message.

set application-group

Description

Removes an application from an existing application group object by application’s ID using group object’s ID.

Syntax

set application-group application-group-id <application-group-id> remove application-id <application-id>

Parameters

Example

set application-group application-group-id 12345678 remove application-id hasMany

Output

Failure shows an appropriate error message.

show application-group

shows the configuration of the Application group objects.

show application-group

Description

Shows the configuration of a specific application group object by ID.

Syntax

show application-group application-group-id <application-group-id>

Parameters

Example

show application-group application-group-id 12345678

Output

Failure shows an appropriate error message.

show application-group

Description

Shows the configuration of a specific application group object by name.

Syntax

show application-group name <name>

Parameters

Example

show application-group name users

Output

Failure shows an appropriate error message.

show application-groups

Description

Shows the configuration of all specific application group objects.

Syntax

show application-groups

Parameters

Example

show application-groups

Output

Failure shows an appropriate error message.

antispoofing

set antispoofing

Description

Configures the activation of the IP address Anti-Spoofing feature.

Syntax

set antispoofing advanced-settings global-activation <global-activation>

Parameters

Example

set antispoofing advanced-settings global-activation true

Output

Failure shows an appropriate error message.

show antispoofing

Description

Shows the configuration for IP addresses Anti-Spoofing functionality.

Syntax

show antispoofing advanced-settings

Parameters

Example

show antispoofing advanced-settings

Output

Failure shows an appropriate error message.

backup settings

Description

Creates a backup file that contains the current settings for the appliance and saves them to a file. The file is saved to either a USB device or TFTP server. You can use these options when the backup file is created:

• Specific file name (The default file name contains the current image and a date and time stamp)
• Password encryption
• Backup policies
• Add a comment to the file

Syntax

backup settings to {usb|tftp server <serverIP>} [filename <filename>] [file-encryption {off|on password <pass>}] [backup-policy {on|off}] [add-comment <comment>]

Parameters

Return Value

0 on success, 1 on failure

Example

backup settings to usb file-encryption on password admin backup-policy on add-comment check_point_new_configuration

Output

Success prints OK. Failure shows an appropriate error message.

Comments

When saving the backup file to a USB device, the backup settings command fails if there are two USB devices connected to the appliance.

show backup settings

Description

Shows previous backup information of the appliance's settings.

show backup-settings-log shows the log file of previous backup settings operations.

Syntax

show backup-settings-{log|info {from tftp server <server> filename <file>|from usb filename <file>}}

Parameters

Example

show backup-settings-log

show backup-settings-info from usb filename backup

Output

Success shows backup settings information. Failure shows an appropriate error message.

blade-update-schedule

set blade-update-schedule

Configures schedule for Software Blade updates.

set blade-update-schedule

Description

Configures schedule forSoftware Blades updates.

Syntax

set blade-update-schedule [ schedule-ips <schedule-ips> ] [ schedule-anti-bot <schedule-anti-bot> ] [ schedule-anti-virus <schedule-anti-virus> ] [ schedule-appi <schedule-appi> ] [ recurrence { daily time <time> | weekly day-of-week <day-of-week> time <time> | hourly hour-interval <hour-interval> | monthly day-of-month <day-of-month> time <time> } ]

Parameters

Example

set blade-update-schedule schedule-ips true schedule-anti-bot true schedule-anti-virus true schedule-appi true recurrence daily time 23:20

Output

Failure shows an appropriate error message.

set blade-update-schedule

Description

Configures advanced settings for Software Blade updates.

Syntax

set blade-update-schedule advanced-settings max-num-of-retries <max-num-of-retries>

Parameters

Example

set blade-update-schedule advanced-settings max-num-of-retries 10

Output

Failure shows an appropriate error message.

set blade-update-schedule

Description

Configures advanced settings for Software Blade updates.

Syntax

set blade-update-schedule advanced-settings timeout-until-retry <timeout-until-retry>

Parameters

Example

set blade-update-schedule advanced-settings timeout-until-retry 10

Output

Failure shows an appropriate error message.

show blade-update-schedule

Shows the configuration of Software Blade updates schedule.

show blade-update-schedule

Description

Shows the configuration of Software Blade updates schedule

Syntax

show blade-update-schedule

Parameters

Example

show blade-update-schedule

Output

Failure shows an appropriate error message.

show blade-update-schedule

Description

Shows advanced settings of Software Blade updates schedule.

Syntax

show blade-update-schedule advanced-settings

Parameters

Example

show blade-update-schedule advanced-settings

Output

Failure shows an appropriate error message.

bookmark

add bookmark

Description

Adds a new bookmark link that will appear for VPN remote access users in the SNX VPN remote access landing page.

Syntax

add bookmark label <label> url <url> [ tooltip <tooltip> ] [ type <type> ] [ is-global <is-global> ] [ user-name <user-name> ] [ password <password> ] [ screen-width <screen-width> ] [ screen-height <screen-height> ]

Parameters

Example

add bookmark label myLabel url http://www.checkpoint.com/ tooltip “This is a comment.” type link is-global true user-name admin password a(&7Ba screen-width 1920 screen-height 1080

Output

failure shows an appropriate error message.

delete bookmark

Deletes an existing bookmark link that appears in the SNX VPN remote access landing page.

delete bookmark

Description

Deletes an existing bookmark link by label.

Syntax

delete bookmark label <label>

Parameters

Example

delete bookmark label myLabel

Output

Failure shows an appropriate error message.

delete bookmark

Description

Deletes all existing bookmark links.

Syntax

delete bookmark all

Parameters

Example

delete bookmark all

Output

Failure shows an appropriate error message.

set bookmark

Description

Configures an existing bookmark shown to users in the SNX landing page.

Syntax

set bookmark [ label <label> ] [ new-label <new-label> ] [ url <url> ] [ tooltip <tooltip> ] [ type <type> ] [ is-global <is-global> ] [ user-name <user-name> ] [ password <password> ] [ screen-width <screen-width> ] [ screen-height <screen-height> ]

Parameters

Example

set bookmark label myLabel new-label myNewLabel url http://www.checkpoint.com/ tooltip myToolTip type link is-global true user-name admin password a(&7Ba screen-width 1920 screen-height

1080

Output

Failure shows an appropriate error message.

show bookmark

Description

Shows the configuration of a bookmark defined to be shown to users when connecting to the SNX portal using remote access VPN.

Syntax

show bookmark label <label>

Parameters

Example

show bookmark label myLabel

Output

Failure shows an appropriate error message.

show bookmarks

Description

Shows all bookmarks defined to be shown to users when connecting to the SNX portal using remote access VPN.

Syntax

show bookmarks

Parameters

Example

show bookmarks

Output

Failure shows an appropriate error message.

bridge

add bridge

Description

Adds a new bridge.

Syntax

add bridge [ name <name> ]

Parameters

Example

add bridge name br7

Output

Failure shows an appropriate error message.

delete bridge

Description

Deletes an existing bridge.

Syntax

delete bridge <name>

Parameters

Example

delete brdige br7

Output

Failure shows an appropriate error message.

set bridge

Configures an existing bridge interface.

set bridge

Description

Configures an existing bridge interface.

Syntax

set bridge <name> stp <stp>

Parameters

Example

set bridge br7 stp on

Output

Failure shows an appropriate error message.

set bridge

Description

Adds an existing network/interface to an existing bridge.

Syntax

set bridge <name> add member <member>

Parameters

Example

set bridge br7 add member My_Network

Output

Failure shows an appropriate error message.

set bridge

Description

Removes an existing network/interface from an existing bridge.

Syntax

set bridge <name> remove member <member>

Parameters

Example

set bridge br7 remove member My_Network

Output

Failure shows an appropriate error message.

show bridge

Description

Shows configuration and statistics of a defined bridge.

Syntax

show bridge <name>

Parameters

Example

show bridge br7

Output

Failure shows an appropriate error message.

show bridges

Description

Shows details of all defined bridges.

Syntax

show bridges

Parameters

Example

show bridges

Output

Failure shows an appropriate error message.

show clock

Description

Shows current system date and time.

Syntax

show clock

Parameters

Example

show clock

Output

Success shows date and time. Failure shows an appropriate error message.

cloud-deployment

set cloud-deployment

Description

Configures different settings for zero-touch deployment. Command is relevant to preset files.

Syntax

set cloud-deployment [ cloud-url <cloud-url> ] [ gateway-name <gateway-name>

] [ template <template> ] [ container <container> ]

Parameters

Example

set cloud-deployment cloud-url http://www.checkpoint.com/ gateway-name My-appliance template TEXT container TEXT

Output

Failure shows an appropriate error message.

show cloud-deployment

Description

Shows the configuration of cloud management connection.

Syntax

show cloud-deployment

Parameters

Example

show cloud-deployment

Output

Failure shows an appropriate error message.

send cloud-report

Description

Force sending a report to Cloud Services.

Syntax

send cloud-report type <type>

Parameters

Example

send cloud-report type top-last-hour

Output

Failure shows an appropriate error message.

cloud-services

reconnect cloud-services

Description

Force a manual reconnection to Cloud Services.

Syntax

reconnect cloud-services

Parameters

Example

reconnect cloud-services

Output

Failure shows an appropriate error message.

set cloud-services

Configures settings for cloud/SMP management connection.

set cloud-services

Description

Configures settings for cloud/SMP management connection.

Syntax

set cloud-services [ { [ activation-key <activation-key> ] | [ [ service-center <service-center> ] [ gateway-id <gateway-id> ] [

registration-key <registration-key> ] ] } ] [ confirm-untrusted-certificate

<confirm-untrusted-certificate> ] [ mode <mode> ]

Parameters

Example

set cloud-services activation-key TEXT confirm-untrusted-certificate true mode off

Output

Failure shows an appropriate error message.

set cloud-services

Description

Configures advanced settings for cloud/SMP management connection.

Syntax

set cloud-services advanced-settings cloud-management-configuration [ smp-login <smp-login> ] [ show-mgmt-server-details-on-login

<show-mgmt-server-details-on-login> ]

Parameters

Example

set cloud-services advanced-settings cloud-management-configuration smp-login true show-mgmt-server-details-on-login true

Output

Failure shows an appropriate error message.

show cloud-services

Description

Shows advanced settings of cloud management connection.

Syntax

show cloud-services advanced-settings

Parameters

Example

show cloud-services advanced-settings

Output

Failure shows an appropriate error message.

show cloud-services connection-details

Description

Shows connection details for cloud management connection.

Syntax

show cloud-services connection-details

Parameters

Example

show cloud-services connection-details

Output

Failure shows an appropriate error message.

cloud-services-firmware-upgrade

set cloud-services-firmware-upgrade

Configure settings for the “firmware upgrade” Cloud Services.

set cloud-services-firmware-upgrade

Description

Configures settings for the “firmware upgrade” Cloud Services.

Syntax

set cloud-services-firmware-upgrade [ activate <activate> ] frequency

{ immediately-when-available | daily time <time> | monthly day-of-month

<day-of-month> time <time> | weekly day-of-week <day-of-week> time <time> }

Parameters

Example

set cloud-services-firmware-upgrade activate true frequency immediately-when-available

Output

Failure shows an appropriate error message.

set cloud-services-firmware-upgrade

Description

Configures advanced settings for the “firmware upgrade” Cloud Services.

Syntax

set cloud-services-firmware-upgrade advanced-settings max-num-of-retries

<max-num-of-retries>

Parameters

Example

set cloud-services-firmware-upgrade advanced-settings max-num-of-retries

15

Output

Failure shows an appropriate error message.

set cloud-services-firmware-upgrade

Description

Configures advanced settings for the “firmware upgrade” Cloud Services.

Syntax

set cloud-services-firmware-upgrade advanced-settings timeout-until-retry

<timeout-until-retry>

Parameters

Example

set cloud-services-firmware-upgrade advanced-settings timeout-until-retry

15

Output

Failure shows an appropriate error message.

show cloud-services-firmware-upgrade

Shows configuration of the "Firmware Upgrade" Cloud Services.

show cloud-services-firmware-upgrade

Description

Shows configuration of the “Firmware Upgrade” Cloud Services.

Syntax

show cloud-services-firmware-upgrade

Parameters

Example

show cloud-services-firmware-upgrade

Output

Failure shows an appropriate error message.

show cloud-services-firmware-upgrade

Description

Shows advanced settings of the “Firmware Upgrade” Cloud Services.

Syntax

show cloud-services-firmware-upgrade advanced-settings

Parameters

Example

show cloud-services-firmware-upgrade advanced-settings

Output

Failure shows an appropriate error message.

show cloud-service managed-blades

Description

Shows the currently managed blades by the cloud management.

Syntax

show cloud-services managed-blades

Parameters

Example

show cloud-services managed-blades

Output

Failure shows an appropriate error message.

show cloud-services managed-services

Description

Shows the currently managed services by the cloud management.

Syntax

show cloud-services managed-services

Parameters

Example

show cloud-services managed-services

Output

Failure shows an appropriate error message.

fetch cloud-services policy

Description

Fetch configuration now from your Cloud Services Security Management Server.

Syntax

fetch cloud-services policy

Parameters

Example

fetch cloud-services policy

Output

Failure shows an appropriate error message.

show cloud-services status

Description

Shows the current status of the cloud management connection.

Syntax

show cloud-services status

Parameters

Example

show cloud-services status

Output

Failure shows an appropriate error message.

show commands

Description

Shows all available CLI commands.

Syntax

show commands

Parameters

Example

show commands

Output

List of all available CLI commands.

cphaprob

Description

Defines and manages the critical cluster member properties of the appliance. When a critical process fails, the appliance is considered to have failed.

Syntax

cphaprob [-i[a]] [-d <device>] [-s {ok|init|problem}] [-f <file>] [-p] [register|unregister|report|list|state|if]

Parameters

Example

cphaprob -d $process -t 0 -s ok -p register

Output

Success prints OK. Failure shows an appropriate error message.

These are some typical scenarios for the cphaprob command.

Examples

cphaprob -d <device> -t <timeout(sec)> -s <ok|init|problem> [-p] register
cphaprob -f <file> register
cphaprob -d <device> [-p] unregister
cphaprob -a unregister
cphaprob -d <device> -s <ok|init|problem> report
cphaprob [-i[a]] [-e] list
cphaprob state
cphaprob [-a] if

cphastop

Description

Disables High Availability on the appliance. Running cphastop on an appliance that is a cluster member stops the appliance from passing traffic. State synchronization also stops.

Syntax

cphastop

Parameters

Return Value

0 on success, 1 on failure

Example

cphastop

Output

Success prints OK. Failure shows an appropriate error message.

cpinfo

Description

Creates a Check Point Support Information (CPinfo) file on a machine at the time of execution.

The files is saved to a USB drive or TFTP server.

The CPinfo output file enables Check Point's support engineers to analyze setups from a remote location.

Syntax

cpinfo {to-tftp <ipaddr>|to-usb}

Parameters

Return Value

0 on success, 1 on failure

Example

cpinfo to-usb

Output

Success prints Creating cpinfo.txt file. Failure shows an appropriate error message.

cpstart

Start all Check Point processes and applications running on a machine.

Description

Starts firewall services.

Syntax

cpstart

Parameters

Return Value

0 on success, 1 on failure

Example

cpstart

Output

Success shows Starting CP products.... Failure shows an appropriate error message.

cpstat

Description

Shows Check Point statistics for applications.

Syntax

cpstat [-p <port>] [-s <SICname>] [-f <flavor>] [-o <polling>] [-c <count>] [-e <period>] [-x] [-j] [-d] application_flag <flag>

Parameters

Return Value

0 on success, 1 on failure

Example

cpstat -c 3 -o 3 fw

Output

Success shows OK. Failure shows an appropriate error message.

The following flavors can be added to the application flags:

• fw — "default", "interfaces", "all", "policy", "perf", "hmem", "kmem", "inspect", "cookies", "chains", "fragments", "totals", "ufp", "http", "ftp", "telnet", "rlogin", "smtp", "pop3", "sync"
• vpn — "default", "product", "IKE", "ipsec", "traffic", "compression", "accelerator", "nic", "statistics", "watermarks", "all"
• fg — "all"
• ha — "default", "all"
• os — "default", "ifconfig", "routing", "memory", "old_memory", "cpu", "disk", "perf", "multi_cpu", "multi_disk", "all", "average_cpu", "average_memory", "statistics"
• mg — "default"
• persistency — "product", "Tableconfig", "SourceConfig"
• polsrv — "default", "all"
• uas — "default"
• svr — "default"
• cpsemd — "default"
• cpsead — "default"
• asm — "default", "WS"
• ls — "default"
• ca — "default", "crl", "cert", user", "all"

cpstop

Description

Stops firewall services and terminates all Check Point processes and applications running on the appliance.

Syntax

cpstop

Parameters

Return Value

0 on success, 1 on failure

Example

cpstop

Output

Success shows Uninstalling Security Policy.... Failure shows an appropriate error message.

cpwd_admin

Description

The cpwd_admin utility can be used to verify if a process is running and to stop and start a process if necessary.

Syntax

cpwd_admin {del <name>|detach <name>|list|kill|exist|start_monitor|stop_monitor|
monitor_list}

Parameters

Return Value

0 on success, 1 on failure

Example

cpwd_admin start_monitor

Output

Success shows OK. Failure shows an appropriate error message.

date

set date

Configures the device’s date and time.

set date

Description

Manually configure the device’s date.

Syntax

set date <date>

Parameters

Example

set date 2000-01-01

Output

Failure shows an appropriate error message.

set date

Description

Manually configure the device’s time.

Syntax

set time <time>

Parameters

Example

set time 23:20

Output

Failure shows an appropriate error message.

set date

Description

Manually configure the device’s time zone.

Syntax

set timezone <timezone>

Parameters

Example

set timezone GMT-11:00(Midway-Island)

Output

Failure shows an appropriate error message.

set date

Description

Configures if the daylight savings will be changed automatically.

Syntax

set timezone-dst automatic <timezone-dst automatic>

Parameters

Example

set timezone-dst automatic on

Output

Failure shows an appropriate error message.

show date

Shows date and time.

show date

Description

Shows current date of the appliance.

Syntax

show date

Parameters

Example

show date

Output

Failure shows an appropriate error message.

show date

Description

Shows current time of the appliance.

Syntax

show time

Parameters

Example

show time

Output

Failure shows an appropriate error message.

show date

Description

Shows current time zone of the appliance.

Syntax

show timezone

Parameters

Example

show timezone

Output

Failure shows an appropriate error message.

show date

Description

Shows current daylight savings configuration of the appliance.

Syntax

show timezone-dst

Parameters

Example

show timezone-dst

Output

Failure shows an appropriate error message.

restore default-settings

Description

Restores the default settings of the appliance without affecting the software image. All the custom user settings for the appliance are deleted.

Syntax

restore default-settings [preserve-sic {yes|no}|preserve-license {yes|no}|force {yes|no}]

Parameters

Return Value

0 on success, 1 on failure

Example

restore default-settings preserve-sic yes

Output

n/a

Comments

The appliance automatically reboots after the default settings are restored.

dhcp-relay

set dhcp-relay

Description

Configures advanced settings for DHCP Relay functionality.

Syntax

set dhcp-relay advanced-settings use-internal-ip-addrs-as-source <use-internal-ip-addrs-as-source>

Parameters

Example

set dhcp-relay advanced-settings use-internal-ip-addrs-as-source true

Output

Failure shows an appropriate error message.

show dhcp-relay

Description

Shows advanced settings for DHCP relay.

Syntax

show dhcp-relay advanced-settings

Parameters

Example

show dhcp-relay advanced-settings

Output

Failure shows an appropriate error message.

show dhcp servers

Description

Shows configuration for all DHCP servers.

Syntax

show dhcp servers

Parameters

Example

show dhcp servers

Output

Failure shows an appropriate error message.

dhcp server interface

delete dhcp server interface

Description

Deletes the configured exclude range from the DHCP server settings of a specific network/interface.

Syntax

delete dhcp server interface <name> exclude-range

Parameters

Example

delete dhcp server interface My_Network exclude-range

Output

Failure shows an appropriate error message.

set dhcp server interface

Configures DHCP server settings.

set dhcp server interface

Description

Configures a custom DHCP option.

Syntax

set dhcp server interface <cliName> custom-option name <custom-option name> type <type> tag <tag> data <data>

Parameters

Example

set dhcp server interface LAN1 custom-option name MyOption type string tag 43 data TEXT

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures if a DHCP server is active or not on an existing network/interface.

Syntax

set dhcp server interface <name> { disable | enable }

Parameters

Example

set dhcp server interface My_Network off

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures DHCP relay functionality on an existing network/interface.

Syntax

set dhcp server interface <name> relay relay-to <relay relay-to> { [ secondary <secondary> ] | [ relay-secondary <relay-secondary> ] }

Parameters

Example

set dhcp server interface My_Network relay relay-to 192.168.1.1 secondary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures an IP address pool for a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> include-ip-pool <include-ip-pool>

Parameters

Example

set dhcp server interface My_Network include-ip-pool 192.168.1.1-192.168.1.10

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the default gateway provided by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> default-gateway <default-gateway>

Parameters

Example

set dhcp server interface My_Network default-gateway auto

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the WINS mode provided by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> wins-mode <wins-mode>

Parameters

Example

set dhcp server interface My_Network wins-mode auto

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the WINS servers IP addresses provided by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> wins primary <wins primary> [ secondary

<secondary> ]

Parameters

Example

set dhcp server interface My_Network wins primary 192.168.1.1 secondary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the lease time used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> lease-time <lease-time>

Parameters

Example

set dhcp server interface My_Network lease-time 30

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the domain used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> domain <domain>

Parameters

Example

set dhcp server interface My_Network domain myHost.com

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the NTP servers used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> ntp <ntp> [ secondary <secondary> ]

Parameters

Example

set dhcp server interface My_Network ntp 192.168.1.1 secondary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the TFTP server used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> tftp <tftp>

Parameters

Example

set dhcp server interface My_Network tftp 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the TFTP bootfile used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> file <file>

Parameters

Example

set dhcp server interface My_Network file word

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the Call Manager servers used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> callmgr <callmgr> [ secondary <secondary> ]

Parameters

Example

set dhcp server interface My_Network callmgr 192.168.1.1 secondary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the X-Windows display manager server used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> xwin-display-mgr <xwin-display-mgr>

Parameters

Example

set dhcp server interface My_Network xwin-display-mgr 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the Avaya Manager server used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> avaya-voip <avaya-voip>

Parameters

Example

set dhcp server interface My_Network avaya-voip 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the Nortel Manager server used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> nortel-voip <nortel-voip>

Parameters

Example

set dhcp server interface My_Network nortel-voip 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the Thomson Manager server used by a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> thomson-voip <thomson-voip>

Parameters

Example

set dhcp server interface My_Network thomson-voip 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the DNS servers provided by a DHCP server on an existing network/interface. In automatic mode the device will provide its own IP address when configured as DNS proxy, and the DNS servers it is configured with otherwise.

Syntax

set dhcp server interface <name> dns { none | manual [ primary <primary> ] [ secondary <secondary> ] [ tertiary <tertiary> ] | auto }

Parameters

Example

set dhcp server interface My_Network dns none

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the primary DNS server provided by a DHCP server on an existing network/interface in manual mode.

Syntax

set dhcp server interface <name> dns primary <dns primary>

Parameters

Example

set dhcp server interface My_Network dns primary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the secondary DNS server provided by a DHCP server on an existing network/interface in manual mode.

Syntax

set dhcp server interface <name> dns secondary <dns secondary>

Parameters

Example

set dhcp server interface My_Network dns secondary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Configures the tertiary DNS server provided by a DHCP server on an existing network/interface in manual mode.

Syntax

set dhcp server interface <name> dns tertiary <dns tertiary>

Parameters

Example

set dhcp server interface My_Network dns tertiary 192.168.1.1

Output

Failure shows an appropriate error message.

set dhcp server interface

Description

Removes a custom DHCP option from a DHCP server on an existing network/interface.

Syntax

set dhcp server interface <name> remove custom-option <custom-option>

Parameters

Example

set dhcp server interface My_Network remove custom-option MyOption

Output

Failure shows an appropriate error message.

show dhcp server interface

Shows configuration of DHCP servers.

show dhcp server interface

Description

Shows the configuration of a DHCP server configured on a specific interface/network.

Syntax

show dhcp server interface <name>

Parameters

Example

show dhcp server interface My_Network

Output

Failure shows an appropriate error message.

show dhcp server interface

Description

Shows the IP address pool of a DHCP server configured on a specific interface/network.

Syntax

show dhcp server interface <name> ip-pool

Parameters

Example

show dhcp server interface My_Network ip-pool

Output

Failure shows an appropriate error message.

show diag

Description

Shows information about your appliance, such as the current firmware version and additional details.

Syntax

show diag

Parameters

Example

show diag

Output

Current system information.

show disk usage

Description

Shows the file system space used and space available.

Syntax

show disk-usage [-h|-m|-k]

Parameters

Example

show disk-usage -h

Output

Current file system space used and space available.

dns

delete dns

Deletes configured DNS settings.

delete dns

Description

Deletes configured primary DNS.

Syntax

delete dns [ primary ipv4-address ]

Parameters

Example

delete dns primary ipv4-address

Output

Failure shows an appropriate error message.

delete dns

Description

Deletes configured secondary DNS.

Syntax

delete dns [ secondary ipv4-address ]

Parameters

Example

delete dns secondary ipv4-address

Output

Failure shows an appropriate error message.

delete dns

Description

Deletes configured tertiary DNS.

Syntax

delete dns [ tertiary ipv4-address ]

Parameters

Example

delete dns tertiary ipv4-address

Output

Failure shows an appropriate error message.

delete dns

Description

Deletes configured domain name of the appliance.

Syntax

delete domainname

Parameters

Example

delete domainname

Output

Failure shows an appropriate error message.

set dns

Configures the DNS and domain settings for the device.

set dns

Description

Configures the DNS settings for the device.

Syntax

set dns [ primary ipv4-address <primary ipv4-address> ] [ secondary ipv4-address <secondary ipv4-address> ] [ tertiary ipv4-address <tertiary ipv4-address> ]

Parameters

Example

set dns primary ipv4-address 192.168.1.1 secondary ipv4-address 192.168.1.1 tertiary ipv4-address 192.168.1.1

Output

Failure shows an appropriate error message.

set dns

Description

Configures the DNS mode for the device. It can either use manually configured DNS servers or use the DNS servers provided to him by the active internet connection from his ISP.

Syntax

set dns mode <mode>

Parameters

Example

set dns mode global

Output

Failure shows an appropriate error message.

set dns

Description

Configures the DNS proxy mode. DNS proxy allows treating the configured network objects as a hosts list which the device can translate from hostname to IP address for local networks.

Syntax

set dns proxy { on [ resolving <resolving> ] | off }

Parameters

Example

set dns proxy on resolving on

Output

Failure shows an appropriate error message.

set dns

Description

Configures the domain settings for the device.

Syntax

set domainname <domainname>

Parameters

Example

set domainname somehost.example.com

Output

Failure shows an appropriate error message.

show dns

Shows configuration for DNS and domain name.

show dns

Description

Shows configuration for DNS.

Syntax

show dns

Parameters

Example

show dns

Output

Failure shows an appropriate error message.

show dns

Description

Shows configuration for domain name.

Syntax

show domainname

Parameters

Example

show domainname

Output

Failure shows an appropriate error message.

dsl

set dsl advanced-settings global-settings

Description

Set DSL configuration parameters.

Syntax

set dsl advanced-settings global-settings [ ginp <ginp> ] [ sra <sra> ]

Parameters

Example

set dsl advanced-settings global-settings ginp downstream-and-upstream sra true

Output

N/A

set dsl advanced-settings standards

Description

Set DSL standard related configuration parameters.

Syntax

set dsl advanced-settings standards [ vdsl2 <true|false> ] [ dmt < true|false > ] [ adsl-lite < true|false > ] [ adsl2 < true|false > ] [ adsl2plus < true|false > ] [ t1413 < true|false > ] [ annex-m < true|false > [ annex-l < true|false > ] [ vdsl-8a < true|false > ] [ vdsl-8b < true|false > ] [ vdsl-8c < true|false > ] [ vdsl-8d < true|false > ] [ vdsl-12a < true|false > ] [ vdsl-12b < true|false >] [ vdsl-17a < true|false > ] [ vdsl-us0 < true|false > ]

Parameters

Example

set dsl advanced-settings standards adsl2plus false

Output

N/A

show dsl advanced-setting

Description

Show all DSL advanced settings parameters.

Syntax

show dsl advanced-settings

Parameters

Example

show dsl advanced-settings

Sample Output

show dsl advanced-settings

adsl2plus: true

vdsl-8d: true

vdsl-8c: true

vdsl-8b: true

annex-m: false

t1413: true

vdsl-17a: true

adsl-lite: true

vdsl2: true

annex-l: false

vdsl-12b: true

adsl2: true

dmt: true

ginp: disabled

sra: false

vdsl8a: true

vdsl-us0: true

vdsl-12a: true

show dsl statistics

Description

Show DSL statistics.

Syntax

show dsl statistics

Parameters

Example

show dsl statistics

Sample Output

show dsl statistics

snr-down: 8.7

configured-ginp: Off/Off

power-up: 7.6

rs-corrected-down: 421298

rs-corrected-up: 208

configured-sra: Off

rs-up: 1610329207

configured-trellis: On

total-cells-down: 2609810117

snr-up: 15.4

tpstc: PTM

bitrate-up: 5024

vectoring: 5 (DSLAM is not a vectored DSLAM)

vendor: IFTN:0xb206

status: Showtime

rs-down: 2127995393

mode: VDSL2 Annex B

hec-up: 0

bitrate-down: 48470

training: Showtime

power-down: 7.7

total-cells-up: 0

hec-down: 0

attn-down: 25.9

attn-up: 0.0

configured-bitswap: Off

dynamic-dns

set dynamic-dns

Configures a persistent domain name for the device.

set dynamic-dns

Description

Configures a persistent domain name for the device.

Syntax

set dynamic-dns { is_active } provider <provider> password <password> user

<user> domain <domain>

Parameters

Example

set dynamic-dns enable provider no-ip.com password a(&7Ba user myUser17

Output

Failure shows an appropriate error message.

set dynamic-dns

Description

Configure advanced settings for the DDNS service.

Syntax

set dynamic-dns advanced-settings iterations <iterations>

Parameters

Example

set dynamic-dns advanced-settings iterations 15

Output

Failure shows an appropriate error message.

show dynamic-dns

Shows configuration for DDNS service.

show dynamic-dns

Description

Shows configuration for DDNS service.

Syntax

show dynamic-dns

Parameters

Example

show dynamic-dns

Output

Failure shows an appropriate error message.

show dynamic-dns

Description

Shows advanced settings for DDNS service.

Syntax

show dynamic-dns advanced-settings

Parameters

Example

show dynamic-dns advanced-settings

Output

Failure shows an appropriate error message.

dynamic objects

Manages dynamic objects on the appliance. The dynamic_objects command specifies an IP address to which the dynamic object is resolved.

First, define the dynamic object in the SmartDashboard. Then create the same object with the CLI (-n argument). After the new object is created on the gateway with the CLI, you can use the dynamic_objects command to specify an IP address for the object.

Any change you make to dynamic objects' ranges are applied immediately to the objects. It is not necessary to reinstall the policy.

Description

Manages dynamic objects on the appliance.

Syntax

dynamic_objects -o <object> [-r <fromIP> <toIP> ...] [-a] [-d] [-l] [-n <object> ] [-c] [-do <object>]

Parameters

Example

dynamic_objects -n sg80gw -r 190.160.1.1 190.160.1.40 -a

Output

Success shows Operation completed successfully. Failure shows an appropriate error message.

exit

Description

Exits from the shell.

Syntax

exit

Parameters

Return Value

None

Example

exit

Output

None

set expert password

Description

Sets the initial password or password hash for the expert shell

Syntax

set expert {password|password-hash} {<pass>|<pass_hash>}

Parameters

Example

set expert password-hash $1$fGT7pGX6$oo9LUBJTkLOGKLhjRQ2rw1

Output

Success shows OK. Failure shows an appropriate error message.

Comments

To generate a password-hash, you can use this command on any Check Point SMB Appliance gateway (as an expert user).

cryptpw –a md5 <password string>

fetch policy

Description

Fetches a policy from the Security Management Server with IPv4 address <ip_addr> or from the local gateway.

Syntax

fetch policy {local|mgmt-ipv4-address <ip_addr>}

Parameters

Return Value

0 on success, 1 on failure

Example

fetch policy mgmt-ipv4-address 192.168.1.100

Output

Success shows Done. Failure shows an appropriate error message.

fw commands

The fw commands are used for working with various aspects of the firewall. All fw commands are executed on the Check Point Security Gateway. For more about the fw commands, see the Command Line Interface (CLI) Reference Guide.

fw commands can be found by typing fw [TAB] at a command line. For some of the CLI commands, you can enter the -h parameter to display all the relevant arguments and parameters. These commands are:

fw policy

set fw policy

Configures the default policy for the Firewall blade

set fw policy

Description

Configures the default policy for the Firewall blade.

Syntax

set fw policy [ mode <mode> ] [ track-allowed-traffic <track-allowed-traffic>

] [ track-blocked-traffic <track-blocked-traffic> ]

Parameters

Example

set fw policy mode off track-allowed-traffic none track-blocked-traffic none

Output

Failure shows an appropriate error message.

set fw policy

Description

Configures advanced settings for the default policy of the Firewall blade.

Syntax

set fw policy advanced-settings blocked-packets-action <blocked-packets-action>

Parameters

Example

set fw policy advanced-settings blocked-packets-action auto

Output

Failure shows an appropriate error message.

set fw policy

Description

Configures advanced settings for the default policy of the Firewall blade.

Syntax

set fw policy advanced-settings log-implied-rules <log-implied-rules>

Parameters

Example

set fw policy advanced-settings log-implied-rules true

Output

Failure shows an appropriate error message.

show fw policy

Shows the configured policy for the Firewall blade.

show fw policy

Description

Shows the configured policy for the Firewall blade.

Syntax

show fw policy

Parameters

Example

show fw policy

Output

Failure shows an appropriate error message.

show fw policy

Description

Shows advanced settings for the Firewall blade.

Syntax

show fw policy advanced-settings

Parameters

Example

show fw policy advanced-settings

Output

Failure shows an appropriate error message.

show fw policy

Description

Shows the configuration for customizable messages shown to users upon actions.

Syntax

show fw policy user-check { block | ask | accept }

Parameters

Example

show fw policy user-check block

Output

Failure shows an appropriate error message.

set fw policy user-check accept

Description

Configures a customizable “accept” message shown to users upon match on browser based traffic.

Syntax

set fw policy user-check accept [ body <body> ] [ fallback-action

<fallback-action> ] [ frequency <frequency> ] [ subject <subject> ] [ title

<title> ]

Parameters

Example

set fw policy user-check accept body My Network fallback-action block frequency day subject My Network title My Network

Output

Failure shows an appropriate error message.

set fw policy user-check ask

Description

Configures a customizable “ask” message shown to users upon match on browser based traffic.

Syntax

set fw policy user-check ask [ body <body> ] [ confirm-text <confirm-text>

] [ fallback-action <fallback-action> ] [ frequency <frequency> ] [ subject

<subject> ] [ title <title> ] [ reason-displayed <reason-displayed> ]

Parameters

Example

set fw policy user-check ask body My Network confirm-text My Network fallback-action block frequency day subject My Network title My Network reason-displayed true

Output

Failure shows an appropriate error message.

set fw policy user-check block

Description

Configures a customizable “block” message shown to users upon match on browser based traffic.

Syntax

set fw policy user-check block [ body <body> ] [ redirect-url <redirect-url>

] [ subject <subject> ] [ title <title> ] [ redirect-to-url <redirect-to-url>]

Parameters

Example

set fw policy user-check block body My Network redirect-url urlWithHttp subject My Network title My Network redirect-to-url true

Output

Failure shows an appropriate error message.

global-radius-conf

set global-radius-conf

Description

Configure the NAS IP\IPv6 address for RADIUS server authentication.

NAS IP\IPv6 address indicates the identifying IP Address of the NAS which is requesting authentication of the user, and should be unique to the NAS within the scope of the RADIUS server.

Syntax

set global-radius-conf [ nas-ip-address <nas-ip-address> ] [ nasIPV6 <nasIPV6> ]

Parameters

Example

set global-radius-conf nas-ip-address 192.168.1.1 nasIPV6 ipv6addr

Output

Failure shows an appropriate error message.

show global-radius-conf

Description

Configure the NAS IP\IPv6 address for RADIUS server authentication.

Syntax

show global-radius-conf

Parameters

Example

show global-radius-conf

Output

Failure shows an appropriate error message.

group

add group

Description

Adds a new group of network objects.

Syntax

add group name <name> [ comments <comments> ] [ member <member> ]

Parameters

Example

add group name myObject_17 comments “This is a comment.” member TEXT

Output

Failure shows an appropriate error message.