Вы находитесь на странице: 1из 263

Check Point 600, 1100, and 1200R Appliance

Command Line Interface


R77.20

Reference Guide

June 17, 2015

Classification: [Protected]
Contents

add access-rule type incoming-internal-and-vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

add access-rule type outgoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

add ad-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

add address-range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

add admin-access-ipv4-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

add administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

add antispam allowed-sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

add antispam blocked-sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

add application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

add application-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

add bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

add group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

add host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

add interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

add interface-loopback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

add internet-connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

add local-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

add local-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

add nat-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

add netflow collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

add network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

add qos-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

add server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

add service-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

add service-icmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

add service-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

add service-tcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

add service-udp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

add snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

add static-route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

add switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Command Line Interface Reference Guide R77.20 Embedded | 1


add threat-prevention anti-virus file-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

add threat-prevention exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

add threat-prevention ips network-exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

add threat-prevention whitelist type-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

add threat-prevention whitelist type-url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

add vpn site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

add wlan vap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

connect security-management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

delete access-rule type incoming-internal-and-vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

delete access-rule type outgoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

delete ad-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

delete address-range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

delete admin-access-ipv4-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

delete administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

delete aggressive-aging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

delete antispam allowed-sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

delete antispam blocked-sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

delete application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

delete application-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

delete bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

delete dhcp server interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

delete dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

delete group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

delete host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

delete interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

delete interface-loopback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

delete internet-connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

delete internet-connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

delete local-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

delete local-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

delete nat-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

delete nat-rule position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

delete netflow collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Command Line Interface Reference Guide R77.20 Embedded | 2


delete network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

delete proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

delete qos-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

delete radius-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

delete server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

delete service-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

delete service-icmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

delete service-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

delete service-tcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

delete service-udp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

delete snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

delete snmp traps-receivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

delete snmp users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

delete static-route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

delete static-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

delete streaming-engine-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

delete switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

delete threat-prevention anti-virus file-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

delete threat-prevention anti-virus file-type custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

delete threat-prevention exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

delete threat-prevention exception position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

delete threat-prevention exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

delete threat-prevention ips network-exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

delete threat-prevention whitelist type-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

delete threat-prevention whitelist type-url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

delete ui-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

delete vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

delete vpn site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

delete wlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

delete wlan vaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

fetch cloud-services policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

find application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

find threat-prevention ips protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Command Line Interface Reference Guide R77.20 Embedded | 3


reconnect cloud-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

send cloud-report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

set access-rule type incoming-internal-and-vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

set access-rule type outgoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

set ad-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

set additional-hw-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

set address-range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

set admin-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

set administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

set administrator session-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

set administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

set aggressive-aging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

set antispam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

set application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

set application-control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

set application-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

set bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

set cloud-deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

set cloud-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

set date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

set device-details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

set dhcp server interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

set dhcp-relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

set dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

set dynamic-dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

set fw policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

set fw policy user-check accept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

set fw policy user-check ask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

set fw policy user-check block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

set group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

set host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

set hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

set https-categorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Command Line Interface Reference Guide R77.20 Embedded | 4


set interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

set internet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

set internet mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

set internet-connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

set ip-fragments-params . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

set ips engine-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

set local-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

set local-group users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

set local-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

set log-servers-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

set loginMessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

set nat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

set nat-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

set nat-rule position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

set netflow collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

set network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

set ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

set ntp server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

set proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

set qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

set qos delay-sensitive-service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

set qos guarantee-bandwidth-selected-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

set qos-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

set radius-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

set reach-my-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

set remote-access users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

set security-management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

set serial-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

set server server-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

set server server-nat-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

set server server-network-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

set server server-ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

set service-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Command Line Interface Reference Guide R77.20 Embedded | 5


set service-icmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

set service-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

set service-tcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

set service-udp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

set snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

set snmp traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

set static-route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

set streaming-engine-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

set switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

set threat-prevention anti-bot engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

set threat-prevention anti-bot policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

set threat-prevention anti-bot user-check ask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

set threat-prevention anti-bot user-check block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

set threat-prevention anti-virus engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

set threat-prevention anti-virus file-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

set threat-prevention anti-virus policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

set threat-prevention anti-virus user-check ask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

set threat-prevention anti-virus user-check block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

set threat-prevention exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

set threat-prevention exception position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

set threat-prevention ips custom-default-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

set threat-prevention ips network-exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

set threat-prevention ips policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

set threat-prevention ips protection-action-override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

set threat-prevention policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

set threat-prevention-advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

set ui-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

set usb-modem-watchdog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

set user-awareness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

set user-awareness browser-based-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

set vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

set vpn remote-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

set vpn remote-access advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Command Line Interface Reference Guide R77.20 Embedded | 6


set vpn remote-access advanced enc-dom-obj manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

set vpn site-to-site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

set vpn site-to-site enc-dom manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

set wlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

set wlan radio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

show access-rule type incoming-internal-and-vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

show access-rule type outgoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

show access-rules type incoming-internal-and-vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

show access-rules type outgoing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

show ad-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

show ad-servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

show additional-hw-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

show address-range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

show address-ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

show admin-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

show admin-access-ipv4-addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

show administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

show administrator session-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

show administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

show administrators radius-auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

show adsl statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

show aggressive-aging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

show antispam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

show antispam allowed-senders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

show antispam blocked-senders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

show application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

show application-control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

show application-control other-undesired-applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

show application-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

show application-groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

show applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

show bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

show bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Command Line Interface Reference Guide R77.20 Embedded | 7


show cloud-deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

show cloud-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

show cloud-services connection-details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

show cloud-services managed-blades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

show cloud-services managed-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

show cloud-services status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

show date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

show device-details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

show dhcp server interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

show dhcp servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

show dhcp servers table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

show dhcp-relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

show dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

show dynamic-dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

show fw policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

show group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

show groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

show host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

show hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

show hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

show https-categorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

show interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

show interfaces all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

show interfaces table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

show internet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

show internet mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

show internet-connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

show internet-connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

show internet-connections table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

show ip-fragments-params . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

show ips engine-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

show local-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Command Line Interface Reference Guide R77.20 Embedded | 8


show local-groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

show local-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

show local-users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

show log-servers-configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

show loginMessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

show nat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

show nat-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

show nat-rule position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

show nat-rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

show netflow collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

show netflow collectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

show network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

show networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

show ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

show ntp active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

show ntp servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

show proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

show qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

show qos delay-sensitive-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

show qos guarantee-bandwidth-selected-services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

show qos-rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

show qos-rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

show radius-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

show radius-servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

show reach-my-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

show remote-access users radius-auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

show security-management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

show serial-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

show server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

show servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

show service-group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

show service-groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

show service-icmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Command Line Interface Reference Guide R77.20 Embedded | 9


show service-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

show service-tcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

show service-udp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

show services-icmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

show services-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

show services-tcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

show services-udp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

show snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

show snmp traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

show snmp traps enabled-traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

show snmp traps receivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

show snmp users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

show snmp-general-all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

show static-routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

show static-routes table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

show streaming-engine-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

show switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

show switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

show threat-prevention anti-bot engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

show threat-prevention anti-bot policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

show threat-prevention anti-bot user-check ask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

show threat-prevention anti-bot user-check block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

show threat-prevention anti-virus engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

show threat-prevention anti-virus file-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

show threat-prevention anti-virus file-types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

show threat-prevention anti-virus policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

show threat-prevention anti-virus user-check ask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

show threat-prevention anti-virus user-check block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

show threat-prevention exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

show threat-prevention exception position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

show threat-prevention exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

show threat-prevention infected-hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

show threat-prevention ips custom-default-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Command Line Interface Reference Guide R77.20 Embedded | 10


show threat-prevention ips network-exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

show threat-prevention ips network-exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

show threat-prevention ips policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

show threat-prevention ips protection-action-override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

show threat-prevention policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

show threat-prevention whitelist files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

show threat-prevention whitelist urls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

show threat-prevention-advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

show ui-settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

show usb-modem-watchdog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

show user-awareness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

show user-awareness browser-based-authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

show vpn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

show vpn remote-access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

show vpn remote-access advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

show vpn site-to-site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

show vpn sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

show vpn tunnels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

show wlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

show wlan radio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

show wlan statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

show wlan vaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

show wlan vaps statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

update security-blades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

Command Line Interface Reference Guide R77.20 Embedded | 11


add access-rule type incoming-internal-and-vpn

Description Firewall rule base

Syntax add access-rule type incoming-internal-and-vpn [ action <action> ] [ log


<log> ] [ source <source> ] [ source-negate <source-negate> ] [ destination
<destination> ] [ destination-negate <destination-negate> ] [ service
<service> ] [ service-negate <service-negate> ] [ disabled <disabled>
] [ comment <comment> ] [ hours-range-enabled { true hours-range-from
<hours-range-from> hours-range-to <hours-range-to> | false } ] [ { position
<position> | position-above <position-above> | position-below <position-below>
} ] [ name <name> ] [ vpn <vpn> ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: block, accept, ask, inform, block-inform
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
Indicates if the rule is disabled
disabled
Type: Boolean (true/false)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
Defines which logging method to use: None - do not log, Log - Create log, Alert
log - log with alert, Account - account rule
Options: none, log, alert, account
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the source is all traffic except what is defined in the source field
source-negate
Type: Boolean (true/false)
Indicates if traffic is matched on encrypted traffic only or all traffic
vpn
Type: Boolean (true/false)

Example add access-rule type incoming-internal-and-vpn action block log none


source TEXT source-negate true destination TEXT destination-negate true
service TEXT service-negate true disabled true comment This is a comment.
hours-range-enabled true hours-range-from 23:20 hours-range-to 23:20 position
2 name word vpn true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 12


add access-rule type outgoing

Description Firewall rule base

Syntax add access-rule type outgoing [ action <action> ] [ log <log> ] [ source
<source> ] [ source-negate <source-negate> ] [ destination <destination>
] [ destination-negate <destination-negate> ] [ service <service> ] [
service-negate <service-negate> ] [ disabled <disabled> ] [ comment
<comment> ] [ hours-range-enabled { true hours-range-from <hours-range-from>
hours-range-to <hours-range-to> | false } ] [ { position <position> |
position-above <position-above> | position-below <position-below> } ] [
name <name> ] [ { [ application-name <application-name> ] | [ application-id
<application-id> ] } ] [ application-negate <application-negate>
] [ limit-application-download { true limit <limit> | false } ] [
limit-application-upload { true limit <limit> | false } ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: block, accept, ask, inform, block-inform
application-id Applications or web sites that are accepted or blocked
application-name Applications or web sites that are accepted or blocked
If true, the rule accepts or blocks all applications but the selected application
application-negate
Type: Boolean (true/false)
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
Indicates if the rule is disabled
disabled
Type: Boolean (true/false)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
Applications traffic upload limit (in kbps)
limit
Type: A number with no fractional part (integer)
If true, download is limited
limit-application-
Type: Boolean (true/false)
download
If true, upload is limited
limit-application-
Type: Boolean (true/false)
upload
Defines which logging method to use: None - do not log, Log - Create log, Alert
log - log with alert, Account - account rule
Options: none, log, alert, account
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 13


source Network object or user group that initiates the connection
If true, the source is all traffic except what is defined in the source field
source-negate
Type: Boolean (true/false)

Example add access-rule type outgoing action block log none source TEXT
source-negate true destination TEXT destination-negate true service
TEXT service-negate true disabled true comment This is a comment.
hours-range-enabled true hours-range-from 23:20 hours-range-to 23:20
position 2 name word application-name hasOne application-negate true
limit-application-download true limit -1000000 limit-application-upload true
limit -1000000

Output Failure shows an appropriate error message.

add ad-server

Description Active directory server object

Syntax add ad-server domain <domain> ipv4-address <ipv4-address> username


<username> password <password> user-dn <user-dn> use-branch-path { true
branch-path <branch-path> | false }

Parameters

Parameter Description
The branch of the domain to be used
branch-path
Type: An LDAP DN
Domain name
domain
Type: Host name
ipv4-address Domain controller IP address
The user’s password
password
Type: A string that contains alphanumeric and special characters
Select only if you want to use only part of the user database defined in the Active
use-branch-path Directory
Type: Boolean (true/false)
FQDN of the user
user-dn
Type: An LDAP DN
A user name with administrator privileges to communicate with the AD server
username
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Example add ad-server domain myHost.com ipv4-address 192.168.1.1 username admin


password a(ˆ
&7Ba user-dn cn=John Doe,dc=example,dc=com use-branch-path true
branch-path cn=John Doe,dc=example,dc=com

Output Failure shows an appropriate error message.

add address-range

Description Address range object

Syntax add address-range name <name> start-ipv4 <start-ipv4> end-ipv4 <end-ipv4> [


dhcp-exclude-ip-addr <dhcp-exclude-ip-addr> ]

Command Line Interface Reference Guide R77.20 Embedded | 14


Parameters

Command Line Interface Reference Guide R77.20 Embedded | 15


Parameter Description
Indicates if the object’s IP address(es) is excluded from internal DHCP daemon
dhcp-exclude-ip-addr
Options: on, off
end-ipv4 The end of the IP range
Network Object name
name
Type: String
start-ipv4 The beginning of the IP range

Example add address-range name TEXT start-ipv4 192.168.1.1 end-ipv4 192.168.1.1


dhcp-exclude-ip-addr on

Output Failure shows an appropriate error message.

add admin-access-ipv4-address

Administrator access IP addresses

add admin-access-ipv4-address
Description Administrator access IP addresses
Syntax add admin-access-ipv4-address single-ipv4-address <single-ipv4-address>

Parameters

Parameter Description
IP address
single-ipv4-address
Type: IP address

Example add admin-access-ipv4-address single-ipv4-address 192.168.1.1

Output Failure shows an appropriate error message.

add admin-access-ipv4-address
Description Administrator access IP addresses

Syntax add admin-access-ipv4-address network-ipv4-address <network-ipv4-address> {


subnet-mask <subnet-mask> | [ mask-length <mask-length> ] }

Parameters

Parameter Description
Subnet mask length
mask-length
Type: A string that contains numbers only
IP address
network-ipv4-address
Type: IP address
Subnet mask
subnet-mask
Type: Subnet mask

Example add admin-access-ipv4-address network-ipv4-address 192.168.1.1 subnet-mask


255.255.255.0

Command Line Interface Reference Guide R77.20 Embedded | 16


Output Failure shows an appropriate error message.

add administrator

Description Configured administrator for the appliance

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


permission <permission>

Parameters

Parameter Description
Virtual field used for calculating a hashed password
password-hash
Type: An encrypted password
Indicates if the administrator has read-only permissions
permission
Options: read-write, readonly
Indicates the administrator user name
username
Type: A string that contains [A-Z], [0-9], and ’_’ characters

Example add administrator username admin password-hash TZXPLs20bN0RA permission


read-write

Output Failure shows an appropriate error message.

add antispam allowed-sender

List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade

add antispam allowed-sender


Description List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade

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

Parameters

Parameter Description
Anti-Spam allowed IP address
ipv4-addr
Type: IP address

Example add antispam allowed-sender ipv4-addr 192.168.1.1


Output Failure shows an appropriate error message.

add antispam allowed-sender


Description List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade
Syntax add antispam allowed-sender sender-or-domain <sender-or-domain>
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 17


Parameter Description
Anti-Spam allowed domain or sender
sender-or-domain
Type: A domain name or email address

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

Output Failure shows an appropriate error message.

add antispam blocked-sender

List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

add antispam blocked-sender


Description List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

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

Parameters

Parameter Description
Anti-Spam blocked IP address
ipv4-addr
Type: IP address

Example add antispam blocked-sender ipv4-addr 192.168.1.1

Output Failure shows an appropriate error message.

add antispam blocked-sender


Description List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

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

Parameters

Parameter Description
Anti-Spam blocked domain or sender
sender-or-domain
Type: A domain name or email address

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

Output Failure shows an appropriate error message.

add application

Database of user-defined URLs

Command Line Interface Reference Guide R77.20 Embedded | 18


add application
Description Database of user-defined URLs

Syntax add application application-name <application-name> category <category> [


regex-url <regex-url> ] application-url <application-url>

Parameters

Parameter Description
Application name
application-name
Type: URL
application-url Contains the URLs related to this application
The primary category for the application (the category which is the most rele-
category
vant)
Indicates if regular expressions are used instead of partial strings
regex-url
Type: Boolean (true/false)

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 Database of user-defined URLs

Syntax add application-url <application-url>

Parameters

Parameter Description
application-url Application URL

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

Output Failure shows an appropriate error message.

add application-group

Description User defined application group

Syntax add application-group name <name>

Parameters

Parameter Description
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Example add application-group name users

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 19


add bridge

Description Bridge configured in the device

Syntax add bridge [ name <name> ]

Parameters

Parameter Description
Bridge name
name
Type: A bridge name can be br0-9

Example add bridge name br7

Output Failure shows an appropriate error message.

add group

Description Network Objects Group model

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

Parameters

Parameter Description
Comments and explanation about the Network Object group
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
member An association field to the contained network objects
Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

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

Output Failure shows an appropriate error message.

add host

Description Address range object

Syntax add host name <name> [ dhcp-exclude-ip-addr { on [ dhcp-reserve-ip-addr-to-mac


{ on mac-addr <mac-addr> | off } ] | off } ] [ dns-resolving <dns-resolving> ]
ipv4-address <ipv4-address>

Parameters

Parameter Description
Indicates if the object’s IP address(es) is excluded from internal DHCP daemon
dhcp-exclude-ip-addr
Type: Press TAB to see available options
Indicates if the IP address is reserved in internal DHCP daemon
dhcp-reserve-ip-addr-
Type: Press TAB to see available options
to-mac

Command Line Interface Reference Guide R77.20 Embedded | 20


Indicates if the name of the server/network object will be used as a hostname
dns-resolving for internal DNS service
Type: Boolean (true/false)
ipv4-address The beginning of the IP range
MAC address of the Network Object
mac-addr
Type: MAC address
Network Object name
name
Type: String

Example add host name TEXT dhcp-exclude-ip-addr on dhcp-reserve-ip-addr-to-mac on


mac-addr 00:1C:7F:21:05:BE dns-resolving true ipv4-address 192.168.1.1

Output Failure shows an appropriate error message.

add interface

Local network

add interface
Description Local network

Syntax add interface <assignment> vlan <vlan>

Parameters

Parameter Description
The switch or bridge which the object belongs to
assignment
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
Enter a number that is the virtual identifier
vlan
Type: A number with no fractional part (integer)

Example add interface My_Network vlan -1000000

Output Failure shows an appropriate error message.

add interface
Description Local network

Syntax add vpn tunnel <vpn tunnel> type { unnumbered peer <peer>
internet-connection <internet-connection> | numbered local <local> remote
<remote> peer <peer> }

Parameters

Parameter Description
internet-connection The local interface for unnumbered VTI
Enter the IP address of the interface
local
Type: IP address

Command Line Interface Reference Guide R77.20 Embedded | 21


Remote peer name as defined in the VPN community. You must define the two
peers in the VPN community before you can define the VTI. The Peer ID is an
peer alpha-numeric character string.
Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces
Defines the remote peer IPv4 address, used at the peer gateway’s point-to-point
remote virtual interface (numbered VTI only)
Type: IP address
The type of VTI: Numbered VTI that uses a specified, static IPv4 addresses for
local and remote connections, or unnumbered VTI that uses the interface and
type
the remote peer name to get addresses
Type: Press TAB to see available options
A number identifying the Virtual Tunnel Interface (VTI)
vpn tunnel
Type: A number with no fractional part (integer)

Example add vpn tunnel -1000000 type unnumbered peer site17 internet-connection My
connection

Output Failure shows an appropriate error message.

add interface-loopback

Description Local network

Syntax add interface-loopback ipv4-address <ipv4-address> { mask-length


<mask-length> | subnet-mask <subnet-mask> }

Parameters

Parameter Description
Enter the IP address of the interface
ipv4-address
Type: IP address
Represents the network’s mask length
mask-length
Type: A string that contains numbers only
Enter the Subnet mask of the specified network
subnet-mask
Type: A subnet mask, or 255.255.255.255

Example add interface-loopback ipv4-address 192.168.1.1 mask-length 20

Output Failure shows an appropriate error message.

add internet-connection

Internet Connection

add internet-connection
Description Internet Connection

Syntax add internet-connection [ name <name> ]

interface {

Command Line Interface Reference Guide R77.20 Embedded | 22


WAN [ { use-connection-as-vlan } vlan-id <vlan-id> ] type { static
ipv4-address <ipv4-address> { subnet-mask <subnet-mask> | mask-length
<mask-length> } default-gw <default-gw> [ dns-primary <dns-primary>
] [ dns-secondary <dns-secondary> ] [ dns-tertiary <dns-tertiary>
] | l2tp username <username> { password <password> | password-hash
<password-hash> } server <server> [ local-ipv4-address <local-ipv4-address>
] [ wan-ipv4-address <wan-ipv4-address> { wan-subnet-mask <wan-subnet-mask>
| wan-mask-length <wan-mask-length> } default-gw <default-gw> ] | dhcp
| pppoe username <username> { password <password> | password-hash
<password-hash> } | pptp username <username> { password <password> |
password-hash <password-hash> } server <server> [ local-ipv4-address
<local-ipv4-address> ] [ wan-ipv4-address <wan-ipv4-address> {
wan-subnet-mask <wan-subnet-mask> | wan-mask-length <wan-mask-length> }
default-gw <default-gw> ] } [ conn-test-timeout <conn-test-timeout> ] |
ADSL type { pppoa username <username> { password <password> | password-hash
<password-hash> } | pppoe username <username> { password <password>
| password-hash <password-hash> } | eoa } [ conn-test-timeout
<conn-test-timeout> ] |
DMZ [ { use-connection-as-vlan } vlan-id <vlan-id> ] type { static
ipv4-address <ipv4-address> { subnet-mask <subnet-mask> | mask-length
<mask-length> } default-gw <default-gw> [ dns-primary <dns-primary>
] [ dns-secondary <dns-secondary> ] [ dns-tertiary <dns-tertiary>
] | l2tp username <username> { password <password> | password-hash
<password-hash> } server <server> [ local-ipv4-address <local-ipv4-address>
] [ wan-ipv4-address <wan-ipv4-address> { wan-subnet-mask <wan-subnet-mask>
| wan-mask-length <wan-mask-length> } default-gw <default-gw> ] | dhcp
| pppoe username <username> { password <password> | password-hash
<password-hash> } | pptp username <username> { password <password> |
password-hash <password-hash> } server <server> [ local-ipv4-address
<local-ipv4-address> ] [ wan-ipv4-address <wan-ipv4-address> {
wan-subnet-mask <wan-subnet-mask> | wan-mask-length <wan-mask-length> }
default-gw <default-gw> ] } [ conn-test-timeout <conn-test-timeout> ]

Parameters

Parameter Description
Connection test timeout
conn-test-timeout
Type: A number with no fractional part (integer)
WAN default gateway (in the advanced section of PPTP and l2TP)
default-gw
Type: IP address
First DNS server IP address
dns-primary
Type: IP address
Second DNS server IP address
dns-secondary
Type: IP address
Third DNS server IP address
dns-tertiary
Type: IP address
Interface name
interface
Type: Press TAB to see available options
IP address field(for static ip and bridge settings)
ipv4-address
Type: IP address
isVlan
isVlan
Type: Boolean (true/false)
Local tunnel IP address or Auto for automatic
local-ipv4-address
Type: An IP address, or ’auto’
Subnet mask length
mask-length
Type: A string that contains numbers only

Command Line Interface Reference Guide R77.20 Embedded | 23


Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Password for PPP connection or cellular modem settings
password
Type: internetPassword
The hash of the user password
password-hash
Type: passwordHash
Server IP address
server
Type: IP address
Subnet mask
subnet-mask
Type: A subnet mask, or 255.255.255.255
Connection type
type
Type: Press TAB to see available options
User name for PPP connection or cellular modem settings
username Type: A string that contains all printable characters but a single or double quote-
like characters. Usually <username>@<ISP>
VLAN ID
vlan-id
Type: A number with no fractional part (integer)
Wan IP address wrapper
wan-ipv4-address
Type: An IP address, or ’auto’
WAN subnet mask length
wan-mask-length
Type: A string that contains numbers only
WAN subnet mask(in the advanced section)
wan-subnet-mask
Type: Subnet mask

Example add internet-connection name My connection interface WAN true vlan-id


-1000000 type static ipv4-address 192.168.1.1 subnet-mask 255.255.255.0
default-gw 192.168.1.1 dns-primary 192.168.1.1 dns-secondary 192.168.1.1
dns-tertiary 192.168.1.1 conn-test-timeout -1000000

Output Failure shows an appropriate error message.

add internet-connection
Description Internet Connection

Syntax add internet-connection type { cellular number <number> [ username


<username> { password <password> | password-hash <password-hash> } ] [ apn
<apn> ] [ conn-test-timeout <conn-test-timeout> ] }

Parameters

Parameter Description
APN (cellular modem settings)
apn
Type: A string that contains [a-z], [0-9], ’-’ and ’.’ characters
Connection test timeout
conn-test-timeout
Type: A number with no fractional part (integer)
Dialed number of the cellular modem settings
number
Type: A sequence of numbers and #,* characters
Password for PPP connection or cellular modem settings
password
Type: internetPassword
The hash of the user password
password-hash
Type: passwordHash
Connection type
type
Type: Press TAB to see available options
User name for PPP connection or cellular modem settings
username Type: A string that contains all printable characters but a single or double quote-
like characters. Usually <username>@<ISP>

Command Line Interface Reference Guide R77.20 Embedded | 24


Example add internet-connection type cellular number 758996 username
MyUsername@MyISP password internetPassword apn my-apn conn-test-timeout
-1000000

Output Failure shows an appropriate error message.

add local-group

Description Local Users Group

Syntax add local-group name <name> [ comments <comments> ] [ remote-access-on


<remote-access-on> ]

Parameters

Parameter Description
Comments
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Local group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Indicates if the users group have remote access permissions
remote-access-on
Type: Boolean (true/false)

Example add local-group name myObject_17 comments This is a comment.


remote-access-on true
Output Failure shows an appropriate error message.

add local-user

Description Configure a local database of users

Syntax add local-user name <name> { password-hash <password-hash> |


password <password> } [ comments <comments> ] [ remote-access-always-on
<remote-access-always-on> ] [ is-temp-user { true expiration-date
<expiration-date> [ expiration-time <expiration-time> ] | false } ]

Parameters

Parameter Description
Comments
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Expiration date for a temporary user in format yyyy-mm-dd
expiration-date
Type: A date format yyyy-mm-dd
Expiration time for a temporary user in format HH:MM
expiration-time
Type: A time format hh:mm
Indicates if the user entry is temporary
is-temp-user
Type: Boolean (true/false)
User’s name in the local database
name
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces
User’s password in the local database
password
Type: A string that contains alphanumeric and special characters

Command Line Interface Reference Guide R77.20 Embedded | 25


User’s hashed password (used for importing database)
password-hash
Type: An encrypted password
Always enable remote access permission for user
remote-access-
Type: Boolean (true/false)
always-on

Example add local-user name admin password-hash TZXPLs20bN0RA comments This is


a comment. remote-access-always-on true is-temp-user true expiration-date
2000-01-01 expiration-time 23:20

Output Failure shows an appropriate error message.

add nat-rule

Description Manual NAT rules

Syntax add nat-rule [ original-source <original-source> ] [ original-destination


<original-destination> ] [ original-service <original-service> ] [
translated-source <translated-source> ] [ translated-destination
<translated-destination> ] [ translated-service <translated-service> ] [
comment <comment> ] [ hide-sources <hide-sources> ] [ enable-arp-proxy
<enable-arp-proxy> ] [ { position <position> | position-above <position-above>
| position-below <position-below> } ] [ name <name> ]

Parameters

Parameter Description
Comment for manual NAT rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
The gateway will reply to ARP requests sent to the original destination’s IP ad-
enable-arp-proxy dress (Does not apply to IP ranges/networks)
Type: Boolean (true/false)
Hide multiple sources behind the translated source addresses
hide-sources
Type: Boolean (true/false)
name
name
Type: A string of alphanumeric characters without space between them
original-destination Original destination of rule
original-service Original service of rule
original-source Original source of rule
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
translated-destination Translated destination of rule
translated-service Translated service of rule
translated-source Translated source of rule

Example add nat-rule original-source TEXT original-destination TEXT


original-service TEXT translated-source TEXT translated-destination TEXT
translated-service TEXT comment This is a comment. hide-sources true
enable-arp-proxy true position 2 name word
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 26


add netflow collector

Description Netflow object table

Syntax add netflow collector ip <ip> port <port> export-format <export-format> [


srcaddr <srcaddr> ] is-enabled <is-enabled>

Parameters

Parameter Description
Export format
export-format
Options: Netflow_V9, Netflow_V5
IP address
ip
Type: IP address
Indicates if netflow is enabled
is-enabled
Type: Boolean (true/false)
UDP port
port
Type: Port number
Source IP address
srcaddr
Type: IP address

Example add netflow collector ip 192.168.1.1 port 8080 export-format Netflow_V9


srcaddr 192.168.1.1 is-enabled true

Output Failure shows an appropriate error message.

add network

Description Address range object

Syntax add network name <name> network-ipv4-address <network-ipv4-address> {


subnet-mask <subnet-mask> | mask-length <mask-length> }

Parameters

Parameter Description
mask-length Mask length
Network Object name
name
Type: String
network-ipv4-address Network address
subnet-mask IP mask used in the related network

Example add network name TEXT network-ipv4-address 172.16.10.0 subnet-mask


255.255.255.0

Output Failure shows an appropriate error message.

add qos-rule

Description QoS rule base rule configuration

Syntax add qos-rule [ source <source> ] [ destination <destination> ] [


service <service> ] [ { [ low-latency-rule { normal [ limit-bandwidth

Command Line Interface Reference Guide R77.20 Embedded | 27


<limit-bandwidth> [ limit-percentage <limit-percentage> ] ] [
guarantee-bandwidth <guarantee-bandwidth> [ guarantee-percentage
<guarantee-percentage> ] ] | low } ] | [ limit-bandwidth <limit-bandwidth>
[ limit-percentage <limit-percentage> ] ] [ guarantee-bandwidth
<guarantee-bandwidth> [ guarantee-percentage <guarantee-percentage> ] ] }
] [ weight <weight> ] [ log <log> ] [ comment <comment> ] [ vpn <vpn> ] [
hours-range-enabled { true hours-range-from <hours-range-from> hours-range-to
<hours-range-to> | false } ] [ diffserv-mark { true diffserv-mark-val
<diffserv-mark-val> | false } ] [ name <name> ] [ { position <position> |
position-above <position-above> | position-below <position-below> } ]

Parameters

Parameter Description
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
DiffServ Mark is a way to mark connections so a third party will handle it. To use
diffserv-mark this option, your ISP or private WAN must support DiffServ
Type: Boolean (true/false)
To mark packets that will be given priority on the public network according to
their DSCP, select DiffServ Mark (1-63) and select a value. You can get the
diffserv-mark-val
DSCP value from your ISP or private WAN administrator
Type: A number with no fractional part (integer)
If true, traffic guarantee is defined
guarantee-bandwidth
Type: Boolean (true/false)
Traffic guarantee percentage
guarantee-percentage
Type: A number with no fractional part (integer)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
If true, traffic limit is defined
limit-bandwidth
Type: Boolean (true/false)
Traffic limit percentage
limit-percentage
Type: A number with no fractional part (integer)
Defines which logging method to use: None - do not log, Log - Create log
log
Options: none, log
The latency of the rule (low or normal)
low-latency-rule
Type: Press TAB to see available options
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
source Network object or user group that initiates the connection
Indicates if traffic is matched on encrypted traffic only or all traffic
vpn
Type: Boolean (true/false)
Traffic weight, relative to the weights defined for other rules
weight
Type: A number with no fractional part (integer)

Example add qos-rule source TEXT destination TEXT service TEXT low-latency-rule
normal limit-bandwidth true limit-percentage -1000000 guarantee-bandwidth

Command Line Interface Reference Guide R77.20 Embedded | 28


true guarantee-percentage -1000000 weight -1000000 log none comment This
is a comment. vpn true hours-range-enabled true hours-range-from 23:20
hours-range-to 23:20 diffserv-mark true diffserv-mark-val -1000000 name word
position 2

Output Failure shows an appropriate error message.

add server

Description Server network object

Syntax add server name <name> ipv4-address <ipv4-address> [ dhcp-exclude-ip-addr


{ on [ dhcp-reserve-ip-addr-to-mac { on mac-addr <mac-addr> | off } ] |
off } ] [ comments <comments> ] [ dns-resolving <dns-resolving> ] type
{ web-server | ftp-server | citrix-server | pptp-server | mail-server |
dns-server | custom-server [ tcpProtocol <tcpProtocol> [ tcp-ports <tcp-ports>
] udpProtocol <udpProtocol> [ udp-ports <udp-ports> ] ] }
Parameters

Parameter Description
Comments
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Indicates if the internal DHCP service will not distribute the configured IP ad-
dhcp-exclude-ip-addr dress of this server/network object to anyone
Type: Press TAB to see available options
Indicates if the internal DHCP service will distribute the configured IP address
dhcp-reserve-ip-addr- only to this server/network object according to its MAC address
to-mac Type: Press TAB to see available options
Indicates if the name of the server/network object will be used as a hostname
dns-resolving for internal DNS service
Type: Boolean (true/false)
ipv4-address The beginning of the IP range
MAC address of the server
mac-addr
Type: MAC address
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
TCP ports for server of type ’other’
tcp-ports
Type: Port range
tcpProtocol
tcpProtocol
Type: Boolean (true/false)
UDP ports for server of type ’other’
udp-ports
Type: Port range
udpProtocol
udpProtocol
Type: Boolean (true/false)

Example add server name myObject_17 ipv4-address 192.168.1.1 dhcp-exclude-ip-addr


on dhcp-reserve-ip-addr-to-mac on mac-addr 00:1C:7F:21:05:BE comments This is
a comment. dns-resolving true type web-server

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 29


add service-group

Description A group of services

Syntax add service-group name <name> [ comments <comments> ] [ member <member> ]

Parameters

Parameter Description
Comments and explanation about the Service Group
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
member An association field for the contained services
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example add service-group name myObject_17 comments This is a comment. member TEXT

Output Failure shows an appropriate error message.

add service-icmp

Description Service objects

Syntax add service-icmp name <name> icmp-code <icmp-code> icmp-type <icmp-type> [


comments <comments> ]

Parameters

Parameter Description
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
ICMP code
icmp-code
Type: A number with no fractional part (integer)
ICMP message type
icmp-type
Type: A number with no fractional part (integer)
Service name
name
Type: String

Example add service-icmp name TEXT icmp-code -1000000 icmp-type -1000000 comments
This is a comment.
Output Failure shows an appropriate error message.

add service-protocol

Description Service objects


Syntax add service-protocol name <name> ip-protocol <ip-protocol> [ comments
<comments> ]
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 30


Parameter Description
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
IP Protocol number
ip-protocol
Type: A number with no fractional part (integer)
Service name
name
Type: String

Example add service-protocol name TEXT ip-protocol -1000000 comments This is a


comment.

Output Failure shows an appropriate error message.

add service-tcp

Description Service objects

Syntax add service-tcp name <name> port <port> [ comments <comments> ]

Parameters

Parameter Description
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Service name
name
Type: String
Destination ports (a comma separated list of ports/ranges)
port
Type: Port range

Example add service-tcp name TEXT port 8080-8090 comments This is a comment.

Output Failure shows an appropriate error message.

add service-udp

Description Service objects

Syntax add service-udp name <name> port <port> [ comments <comments> ]

Parameters

Parameter Description
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Service name
name
Type: String
Destination ports (a comma separated list of ports/ranges)
port
Type: Port range

Example add service-udp name TEXT port 8080-8090 comments This is a comment.

Command Line Interface Reference Guide R77.20 Embedded | 31


Output Failure shows an appropriate error message.

add snmp

Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of notifying the
manager that something is wrong

add snmp
Description Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of
notifying the manager that something is wrong

Syntax add snmp traps-receiver <traps-receiver> version { v2 community <community>


| v3 user <user> }

Parameters

Parameter Description
Community name of the receivers trap, public is default for version2 users
community
Type: A string of alphanumeric characters without space between them
Receivers IP address that the trap associated with
traps-receiver
Type: IP address
user SNMP version3 Defined users
SNMP Version number, options are: v2 or v3
version
Type: Press TAB to see available options

Example add snmp traps-receiver 192.168.1.1 version v2 community word

Output Failure shows an appropriate error message.

add snmp
Description SNMP version3 user configuration options for: security level, authentication settings and passwords

Syntax add snmp user <user> security-level { true auth-pass-type <auth-pass-type>


auth-pass-phrase <auth-pass-phrase> privacy-pass-type <privacy-pass-type>
privacy-pass-phrase <privacy-pass-phrase> | false auth-pass-type
<auth-pass-type> auth-pass-phrase <auth-pass-phrase> }

Parameters

Parameter Description
Authentication password for the SNMP version3 user
auth-pass-phrase
Type: A string that contains alphanumeric and special characters
Authentication protocol type for the version3 user, options are: MD5 or SHA1
auth-pass-type
Options: MD5, SHA1
Privacy password chosen by the version3 user in case privacy is set
privacy-pass-phrase
Type: A string that contains alphanumeric and special characters
Privacy protocol type for the version3 user, options are: AES or DES
privacy-pass-type
Options: AES, DES
Does Privacy protocol for this version3 user was set in the security level
security-level
Type: Boolean (true/false)
version3 user name
user
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Command Line Interface Reference Guide R77.20 Embedded | 32


Example add snmp user admin security-level true auth-pass-type MD5 auth-pass-phrase
a(ˆ
&7Ba privacy-pass-type AES privacy-pass-phrase a(ˆ
&7Ba
Output Failure shows an appropriate error message.

add static-route

Description Static routes

Syntax add static-route [ source <source> ] [ service <service> ] [ destination


<destination> ] [ nexthop gateway { logical <logical> | ipv4-address
<ipv4-address> } ] [ metric <metric> ]

Parameters

Parameter Description
IP address and subnet length of the destination of the packet in the format
destination IP/subnet. e.g. 192.168.0.0/16
Type: An IP address with a mask length
Metric
metric
Type: A number with no fractional part (integer)
Route service name
service
Type: String
IP address and subnet length of the source of the packet in the format IP/subnet.
source e.g. 192.168.1.0/24
Type: An IP address with a mask length

Example add static-route source 172.15.47.0/24 service TEXT destination


172.15.47.0/24 nexthop gateway logical My_Network metric -1000000

Output Failure shows an appropriate error message.

add switch

Description Switch

Syntax add switch name <name>

Parameters

Parameter Description
Name
name
Type: A switch name can be LAN[1-8]_Switch

Example add switch name LAN2_Switch

Output Failure shows an appropriate error message.

add threat-prevention anti-virus file-type

Description Manage Anti-Virus policy per file type

Command Line Interface Reference Guide R77.20 Embedded | 33


Syntax add threat-prevention anti-virus file-type extension <extension> [ action
<action> ] [ description <description> ]
Parameters

Parameter Description
Indicates the action when the file type is detected
action
Options: block, pass, scan
The file description
description Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
File extension that represents this file type
extension Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Example add threat-prevention anti-virus file-type extension This is a comment.


action block description This is a comment.

Output Failure shows an appropriate error message.

add threat-prevention exception

Description Malware exceptions

Syntax add threat-prevention exception [ comment <comment> ] [ scope <scope> ]


protection <protection> action <action> log <log> [ name <name> ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: ask, prevent, detect, inactive
Additional description for the exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
The logging method used when there is a match on the rule: None - do not log,
log Log - Create log, Alert - log with alert
Options: none, log, alert
The name of the exception
name
Type: A string of alphanumeric characters without space between them
The blade to which the exception applies: Anti-Virus and Anti-Bot (malware),
protection Anti-Virus (antivirus) or Anti-Bot (antibot)
Options: any, any-ab, any-av
scope IP address, network object or user group that the exception applies to

Example add threat-prevention exception comment This is a comment. scope TEXT


protection any action ask log none name word

Output Failure shows an appropriate error message.

add threat-prevention ips network-exception

Configure exception rules to bypass IPS protections for specific traffic

Command Line Interface Reference Guide R77.20 Embedded | 34


add threat-prevention ips network-exception
Description Configure exception rules to bypass IPS protections for specific traffic

Syntax add threat-prevention ips network-exception protection-name


<protection-name> [ destination <destination> ] [ destination-negate
<destination-negate> ] [ service <service> ] [ service-negate <service-negate>
] [ source <source> ] [ source-negate <source-negate> ] [ comment <comment> ]

Parameters

Parameter Description
Comment on the IPS Network exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
protection-name Indicates if the exception rule will be matched on all IPS protections or a specific
one
service Type of network service that is under exception
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the service is everything except what is defined in the service field
source-negate
Type: Boolean (true/false)

Example add threat-prevention ips network-exception protection-name word


destination TEXT destination-negate true service TEXT service-negate true
source TEXT source-negate true comment This is a comment.
Output Failure shows an appropriate error message.

add threat-prevention ips network-exception


Description Configure exception rules to bypass IPS protections for specific traffic

Syntax add threat-prevention ips network-exception [ protection-code


<protection-code> ] [ destination <destination> ] [ destination-negate
<destination-negate> ] [ service <service> ] [ service-negate <service-negate>
] [ source <source> ] [ source-negate <source-negate> ] [ comment <comment> ]

Parameters

Parameter Description
Comment on the IPS Network exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
protection-code Indicates if the exception rule will be matched on all IPS protections or a specific
one
service Type of network service that is under exception
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the service is everything except what is defined in the service field
source-negate
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 35


Example add threat-prevention ips network-exception protection-code -1000000
destination TEXT destination-negate true service TEXT service-negate true
source TEXT source-negate true comment This is a comment.

Output Failure shows an appropriate error message.

add threat-prevention whitelist type-file

Description Threat prevention whitelist file

Syntax add threat-prevention whitelist type-file md5 <md5>


Parameters

Parameter Description
MD5 encryption for the file in the whitelist
md5 Type: MD5 checksum of a file. Contains only [a-f] and [0-9] characters and of
exact length of 32

Example add threat-prevention whitelist type-file md5 d41d8cd98f00b204e9800998ecf8427e

Output Failure shows an appropriate error message.

add threat-prevention whitelist type-url

Description Threat Prevention whitelist URL

Syntax add threat-prevention whitelist type-url url <url>

Parameters

Parameter Description
URL
url
Type: URL

Example add threat-prevention whitelist type-url url http://somehost.example.com

Output Failure shows an appropriate error message.

add vpn site

Description Configure remote VPN sites


Syntax add vpn site name <name>

remote-site-link-selection {

host-name remote-site-host-name <remote-site-host-name> auth-method


{ preshared-secret password <password> [ enabled <enabled>
] [ remote-site-enc-dom-type <remote-site-enc-dom-type>
] [ enc-profile <enc-profile> ] [ phase1-reneg-interval
<phase1-reneg-interval> ] [ phase2-reneg-interval <phase2-reneg-interval>

Command Line Interface Reference Guide R77.20 Embedded | 36


] [ enable-perfect-forward-secrecy { true [ phase2-dh <phase2-dh> ] |
false } ] [ is-check-point-site { true [ enable-permanent-vpn-tunnel
<enable-permanent-vpn-tunnel> ] | false } ] [ disable-nat <disable-nat>
] [ aggressive-mode-enabled { true aggressive-mode-DH-group
<aggressive-mode-DH-group> [ { aggressive-mode-enable-peer-id {
true aggressive-mode-peer-id-type <aggressive-mode-peer-id-type>
aggressive-mode-peer-id <aggressive-mode-peer-id> | false } |
aggressive-mode-enable-gateway-id { true aggressive-mode-gateway-id-type
<aggressive-mode-gateway-id-type> aggressive-mode-gateway-id
<aggressive-mode-gateway-id> | false } } ] | false } ] [ enc-method
<enc-method> ] [ use-trusted-ca <use-trusted-ca> ] [ match-cert-ip
<match-cert-ip> ] [ match-cert-dn { true match-cert-dn-string
<match-cert-dn-string> | false } ] [ match-cert-e-mail { true
match-cert-e-mail-string <match-cert-e-mail-string> | false } ]
[ link-selection-probing-method <link-selection-probing-method>
] | certificate [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false } ] [
link-selection-probing-method <link-selection-probing-method> ] } |
ip-address remote-site-ip-address <remote-site-ip-address> is-site-behind-static-nat
{ true static-nat-ip <static-nat-ip> auth-method { preshared-secret
password <password> [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false
} ] [ link-selection-probing-method <link-selection-probing-method>
] | certificate [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval

Command Line Interface Reference Guide R77.20 Embedded | 37


<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false }
] [ link-selection-probing-method <link-selection-probing-method> ] }
| false auth-method { preshared-secret password <password> [ enabled
<enabled> ] [ remote-site-enc-dom-type <remote-site-enc-dom-type>
] [ enc-profile <enc-profile> ] [ phase1-reneg-interval
<phase1-reneg-interval> ] [ phase2-reneg-interval <phase2-reneg-interval>
] [ enable-perfect-forward-secrecy { true [ phase2-dh <phase2-dh> ] |
false } ] [ is-check-point-site { true [ enable-permanent-vpn-tunnel
<enable-permanent-vpn-tunnel> ] | false } ] [ disable-nat <disable-nat>
] [ aggressive-mode-enabled { true aggressive-mode-DH-group
<aggressive-mode-DH-group> [ { aggressive-mode-enable-peer-id {
true aggressive-mode-peer-id-type <aggressive-mode-peer-id-type>
aggressive-mode-peer-id <aggressive-mode-peer-id> | false } |
aggressive-mode-enable-gateway-id { true aggressive-mode-gateway-id-type
<aggressive-mode-gateway-id-type> aggressive-mode-gateway-id
<aggressive-mode-gateway-id> | false } } ] | false } ] [ enc-method
<enc-method> ] [ use-trusted-ca <use-trusted-ca> ] [ match-cert-ip
<match-cert-ip> ] [ match-cert-dn { true match-cert-dn-string
<match-cert-dn-string> | false } ] [ match-cert-e-mail { true
match-cert-e-mail-string <match-cert-e-mail-string> | false } ]
[ link-selection-probing-method <link-selection-probing-method>
] | certificate [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false } ] [
link-selection-probing-method <link-selection-probing-method> ] } } |
load-sharing link-selection-multiple-addrs addr <link-selection-multiple-addrs
addr> auth-method { preshared-secret password <password> [ enabled
<enabled> ] [ remote-site-enc-dom-type <remote-site-enc-dom-type>
] [ enc-profile <enc-profile> ] [ phase1-reneg-interval

Command Line Interface Reference Guide R77.20 Embedded | 38


<phase1-reneg-interval> ] [ phase2-reneg-interval <phase2-reneg-interval>
] [ enable-perfect-forward-secrecy { true [ phase2-dh <phase2-dh> ] |
false } ] [ is-check-point-site { true [ enable-permanent-vpn-tunnel
<enable-permanent-vpn-tunnel> ] | false } ] [ disable-nat <disable-nat>
] [ aggressive-mode-enabled { true aggressive-mode-DH-group
<aggressive-mode-DH-group> [ { aggressive-mode-enable-peer-id {
true aggressive-mode-peer-id-type <aggressive-mode-peer-id-type>
aggressive-mode-peer-id <aggressive-mode-peer-id> | false } |
aggressive-mode-enable-gateway-id { true aggressive-mode-gateway-id-type
<aggressive-mode-gateway-id-type> aggressive-mode-gateway-id
<aggressive-mode-gateway-id> | false } } ] | false } ] [ enc-method
<enc-method> ] [ use-trusted-ca <use-trusted-ca> ] [ match-cert-ip
<match-cert-ip> ] [ match-cert-dn { true match-cert-dn-string
<match-cert-dn-string> | false } ] [ match-cert-e-mail { true
match-cert-e-mail-string <match-cert-e-mail-string> | false } ]
[ link-selection-probing-method <link-selection-probing-method>
] | certificate [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false } ] [
link-selection-probing-method <link-selection-probing-method> ] } |
high-availability link-selection-multiple-addrs addr <link-selection-multiple-addrs
addr> auth-method { preshared-secret password <password> [ enabled
<enabled> ] [ remote-site-enc-dom-type <remote-site-enc-dom-type>
] [ enc-profile <enc-profile> ] [ phase1-reneg-interval
<phase1-reneg-interval> ] [ phase2-reneg-interval <phase2-reneg-interval>
] [ enable-perfect-forward-secrecy { true [ phase2-dh <phase2-dh> ] |
false } ] [ is-check-point-site { true [ enable-permanent-vpn-tunnel
<enable-permanent-vpn-tunnel> ] | false } ] [ disable-nat <disable-nat>
] [ aggressive-mode-enabled { true aggressive-mode-DH-group
<aggressive-mode-DH-group> [ { aggressive-mode-enable-peer-id {
true aggressive-mode-peer-id-type <aggressive-mode-peer-id-type>
aggressive-mode-peer-id <aggressive-mode-peer-id> | false } |
aggressive-mode-enable-gateway-id { true aggressive-mode-gateway-id-type
<aggressive-mode-gateway-id-type> aggressive-mode-gateway-id
<aggressive-mode-gateway-id> | false } } ] | false } ] [ enc-method
<enc-method> ] [ use-trusted-ca <use-trusted-ca> ] [ match-cert-ip
<match-cert-ip> ] [ match-cert-dn { true match-cert-dn-string
<match-cert-dn-string> | false } ] [ match-cert-e-mail { true
match-cert-e-mail-string <match-cert-e-mail-string> | false } ]
[ link-selection-probing-method <link-selection-probing-method>
] | certificate [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [

Command Line Interface Reference Guide R77.20 Embedded | 39


phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false } ] [
link-selection-probing-method <link-selection-probing-method> ] } |
connection-initiated-only-from-remote-site auth-method { preshared-secret
password <password> [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false
} ] [ link-selection-probing-method <link-selection-probing-method>
] | certificate [ enabled <enabled> ] [ remote-site-enc-dom-type
<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true
[ phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true
[ enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] |
false } ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled
{ true aggressive-mode-DH-group <aggressive-mode-DH-group> [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id
<aggressive-mode-peer-id> | false } | aggressive-mode-enable-gateway-id
{ true aggressive-mode-gateway-id-type <aggressive-mode-gateway-id-type>
aggressive-mode-gateway-id <aggressive-mode-gateway-id> | false
} } ] | false } ] [ enc-method <enc-method> ] [ use-trusted-ca
<use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [ match-cert-dn { true
match-cert-dn-string <match-cert-dn-string> | false } ] [ match-cert-e-mail
{ true match-cert-e-mail-string <match-cert-e-mail-string> | false } ] [
link-selection-probing-method <link-selection-probing-method> ] }

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 40


Parameter Description
aggressive-mode-DH- determine the strength of the key when aggressive mode is enabled
group
Indicates if gateway ID matching will be used. This adds a layer of security to
aggressive-mode- aggressive mode
enable-gateway-id Type: Boolean (true/false)
Indicates if peer ID matching will be used. This adds a layer of security to
aggressive-mode- aggressive mode
enable-peer-id Type: Boolean (true/false)
Indicates if Aggressive mode, a less secure negotiation protocol compared to
main mode, is used. It is less recommended if the remote site supports IPSec
aggressive-mode-
main mode
enabled
Type: Boolean (true/false)
The gateway ID that will be used for matching when configured to
aggressive-mode-
Type: vpnAggressiveModePeerId
gateway-id
Indicates the type of gateway ID that will be used for matching when configured
aggressive-mode-
Options: domain-name, user-name
gateway-id-type
The peer ID that will be used for matching when configured to
aggressive-mode-
Type: vpnAggressiveModePeerId
peer-id
Indicates the type of peer ID that will be used for matching when configured
aggressive-mode-
Options: domain-name, user-name
peer-id-type
Indicates the type of authentication used when connecting to the remote site
auth-method
Type: Press TAB to see available options
Disable NAT for traffic to/from the remote site. Useful when one of the internal
disable-nat networks contains a server
Type: Boolean (true/false)
Ensures that a session key will not be compromised if one of the (long-term)
enable-perfect- private keys is compromised in the future.
forward-secrecy Type: Boolean (true/false)
VPN Tunnels are constantly kept active and as a result, make it easier to recog-
enable-permanent- nize malfunctions and connectivity problems
vpn-tunnel Type: Boolean (true/false)
Indicates whether or not the remote site is enabled
enabled
Type: Boolean (true/false)
Indicates which encryption method is used
enc-method
Options: ike-v1, ike-v2, prefer-ike-v2
Encryption profile (one of predefined profiles or custom)
enc-profile
Type: virtual
Enable if the remote site is connected through a Check Point Security Gateway
is-check-point-site
Type: Boolean (true/false)
Indicates if the remote site is behind static NAT
is-site-behind-static-
Type: Boolean (true/false)
nat
link-selection-multiple- IP address
addrs addr
The type of probing used for link selection when multiple IP addresses are con-
link-selection-probing- figured for the remote site
method Options: ongoing, one-time
Indicates if certificate matching should match the DN string in the certificate to
match-cert-dn the configured DN string
Type: Boolean (true/false)
Indicates the configured DN string for certificate matching
match-cert-dn-string
Type: String
Indicates if certificate matching should match the E-mail string in the certificate
match-cert-e-mail to the configured E-mail string
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 41


Indicates the configured E-mail string for certificate matching
match-cert-e-mail-
Type: Email address
string
Indicates if certificate matching should match IP address in the certificate to the
match-cert-ip site’s IP address
Type: Boolean (true/false)
Site name
name Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces
Preshared secret (minimum 6 characters) to be used when authentication
password method is configured as such
Type: vpnPassword
The period, in minutes, between each IKE SA renegotiation
phase1-reneg-interval
Type: A number with no fractional part (integer)
Determine the strength of the key used for the IPsec (Phase 2) key exchange
phase2-dh process. The higher the group number, the stronger and more secure the key
is.
The period, in seconds, between each IPSec SA renegotiation
phase2-reneg-interval
Type: A number with no fractional part (integer)
The method of defining the remote site’s encryption domain
remote-site-enc-dom- Options: manually-defined-enc-dom, route-all-traffic-to-site, route-based-vpn,
type enc-dom-hidden-behind-remote-site
Indicates the host name of the remote site
remote-site-host-
Type: An IP address or host name
name
Indicates the IP address of the remote site
remote-site-ip-
Type: IP address
address
Indicates the method of determining the destination IP address/s of the remote
remote-site-link- site
selection Type: Press TAB to see available options
Indicates an external routable IP address via static NAT used by the remote site
static-nat-ip
Type: IP address
Indicates if a specific trusted CA is used for matching the remote site’s certificate
use-trusted-ca
or all configured trusted CAs

Example add vpn site name site17 remote-site-link-selection host-name


remote-site-host-name myHost.com auth-method preshared-secret password
vpnPassword enabled true remote-site-enc-dom-type manually-defined-enc-dom
enc-profile virtual phase1-reneg-interval -1000000 phase2-reneg-interval
-1000000 enable-perfect-forward-secrecy true phase2-dh word
is-check-point-site true enable-permanent-vpn-tunnel true disable-nat
true aggressive-mode-enabled true aggressive-mode-DH-group word
aggressive-mode-enable-peer-id true aggressive-mode-peer-id-type domain-name
aggressive-mode-peer-id vpnAggressiveModePeerId enc-method ike-v1
use-trusted-ca TEXT match-cert-ip true match-cert-dn true match-cert-dn-string
TEXT match-cert-e-mail true match-cert-e-mail-string MyEmail@mail.com
link-selection-probing-method ongoing enabled true remote-site-enc-dom-type
manually-defined-enc-dom enc-profile virtual phase1-reneg-interval
-1000000 phase2-reneg-interval -1000000 enable-perfect-forward-secrecy
true phase2-dh word is-check-point-site true enable-permanent-vpn-tunnel
true disable-nat true aggressive-mode-enabled true aggressive-mode-DH-group
word aggressive-mode-enable-peer-id true aggressive-mode-peer-id-type
domain-name aggressive-mode-peer-id vpnAggressiveModePeerId enc-method
ike-v1 use-trusted-ca TEXT match-cert-ip true match-cert-dn true
match-cert-dn-string TEXT match-cert-e-mail true match-cert-e-mail-string
MyEmail@mail.com link-selection-probing-method ongoing auth-method
preshared-secret password vpnPassword enabled true remote-site-enc-dom-type
manually-defined-enc-dom enc-profile virtual phase1-reneg-interval

Command Line Interface Reference Guide R77.20 Embedded | 42


-1000000 phase2-reneg-interval -1000000 enable-perfect-forward-secrecy
true phase2-dh word is-check-point-site true enable-permanent-vpn-tunnel
true disable-nat true aggressive-mode-enabled true aggressive-mode-DH-group
word aggressive-mode-enable-peer-id true aggressive-mode-peer-id-type
domain-name aggressive-mode-peer-id vpnAggressiveModePeerId enc-method ike-v1
use-trusted-ca TEXT match-cert-ip true match-cert-dn true match-cert-dn-string
TEXT match-cert-e-mail true match-cert-e-mail-string MyEmail@mail.com
link-selection-probing-method ongoing enabled true remote-site-enc-dom-type
manually-defined-enc-dom enc-profile virtual phase1-reneg-interval
-1000000 phase2-reneg-interval -1000000 enable-perfect-forward-secrecy
true phase2-dh word is-check-point-site true enable-permanent-vpn-tunnel
true disable-nat true aggressive-mode-enabled true aggressive-mode-DH-group
word aggressive-mode-enable-peer-id true aggressive-mode-peer-id-type
domain-name aggressive-mode-peer-id vpnAggressiveModePeerId enc-method ike-v1
use-trusted-ca TEXT match-cert-ip true match-cert-dn true match-cert-dn-string
TEXT match-cert-e-mail true match-cert-e-mail-string MyEmail@mail.com
link-selection-probing-method ongoing
Output Failure shows an appropriate error message.

add wlan vap

Description Virtual Access Point

Syntax add wlan vap ssid <ssid>

Parameters

Parameter Description
Wireless network name (SSID)
ssid
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and space characters

Example add wlan vap ssid My wireless

Output Failure shows an appropriate error message.

connect security-management

Description Security management settings

Syntax connect security-management mgmt-addr <mgmt-addr> use-one-time-password


<use-one-time-password> local-override-mgmt-addr { true send-logs-to {
local-override-log-server-addr addr <addr> | local-override-mgmt-addr } |
false }

Parameters

Parameter Description
The logs are sent to this address
addr
Type: An IP address or host name
Indicates if the management address used in the next manual fetch command
will be saved and continuously used instead of the address downloaded in the
local-override-mgmt-
policy
addr
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 43


The IP address or hostname of the security management server
mgmt-addr
Type: An IP address or host name
Indicates from where the address of the log server is taken
send-logs-to
Type: Press TAB to see available options
Indicates whether to connect to the security management server using a one
use-one-time- time password
password Type: Boolean (true/false)

Example connect security-management mgmt-addr myHost.com use-one-time-password true


local-override-mgmt-addr true send-logs-to local-override-log-server-addr addr
myHost.com

Output Failure shows an appropriate error message.

delete access-rule type incoming-internal-and-vpn

Firewall rule base

delete access-rule type incoming-internal-and-vpn


Description Firewall rule base

Syntax delete access-rule type incoming-internal-and-vpn name <name>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them

Example delete access-rule type incoming-internal-and-vpn name word


Output Failure shows an appropriate error message.

delete access-rule type incoming-internal-and-vpn


Description Firewall rule base

Syntax delete access-rule type incoming-internal-and-vpn position <position>


Parameters

Parameter Description
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Example delete access-rule type incoming-internal-and-vpn position 2

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 44


delete access-rule type outgoing

Firewall rule base

delete access-rule type outgoing


Description Firewall rule base

Syntax delete access-rule type outgoing position <position>

Parameters

Parameter Description
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Example delete access-rule type outgoing position 2

Output Failure shows an appropriate error message.

delete access-rule type outgoing


Description Firewall rule base

Syntax delete access-rule type outgoing name <name>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them

Example delete access-rule type outgoing name word


Output Failure shows an appropriate error message.

delete ad-server

Description Active directory server object

Syntax delete ad-server <domain>

Parameters

Parameter Description
Domain name
domain
Type: Host name

Example delete ad-server myHost.com

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 45


delete address-range

Description Address range object

Syntax delete address-range <name>

Parameters

Parameter Description
Network Object name
name
Type: String

Example delete address-range TEXT

Output Failure shows an appropriate error message.

delete admin-access-ipv4-address

Description Administrator access IP addresses

Syntax delete admin-access-ipv4-address <ipv4-address>

Parameters

Parameter Description
IP address
ipv4-address
Type: IP address

Example delete admin-access-ipv4-address 192.168.1.1

Output Failure shows an appropriate error message.

delete administrator

Description Configured administrator for the appliance


Syntax delete administrator username <username>

Parameters

Parameter Description
Indicates the administrator user name
username
Type: A string that contains [A-Z], [0-9], and ’_’ characters

Example delete administrator username admin

Output Failure shows an appropriate error message.

delete aggressive-aging

Description Connections aggressive aging

Command Line Interface Reference Guide R77.20 Embedded | 46


Syntax delete aggressive-aging

Parameters There are no parameters

Example delete aggressive-aging

Output Failure shows an appropriate error message.

delete antispam allowed-sender

List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade

delete antispam allowed-sender


Description List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade

Syntax delete antispam allowed-sender all

Parameters There are no parameters

Example delete antispam allowed-sender all

Output Failure shows an appropriate error message.

delete antispam allowed-sender


Description List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade
Syntax delete antispam allowed-sender sender-or-domain <sender-or-domain>

Parameters

Parameter Description
Anti-Spam allowed domain or sender
sender-or-domain
Type: A domain name or email address

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

Output Failure shows an appropriate error message.

delete antispam allowed-sender


Description List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade

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

Parameters

Parameter Description
Anti-Spam allowed IP address
ipv4-addr
Type: IP address

Example delete antispam allowed-sender ipv4-addr 192.168.1.1

Command Line Interface Reference Guide R77.20 Embedded | 47


Output Failure shows an appropriate error message.

delete antispam blocked-sender

List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

delete antispam blocked-sender


Description List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

Syntax delete antispam blocked-sender all

Parameters There are no parameters

Example delete antispam blocked-sender all

Output Failure shows an appropriate error message.

delete antispam blocked-sender


Description List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

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

Parameters

Parameter Description
Anti-Spam blocked domain or sender
sender-or-domain
Type: A domain name or email address

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

Output Failure shows an appropriate error message.

delete antispam blocked-sender


Description List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

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

Parameters

Parameter Description
Anti-Spam blocked IP address
ipv4-addr
Type: IP address

Example delete antispam blocked-sender ipv4-addr 192.168.1.1

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 48


delete application

Database of user-defined URLs

delete application
Description Database of user-defined URLs

Syntax delete application application-id <application-id>

Parameters

Parameter Description
The ID of the application
application-id
Type: A number with no fractional part (integer)

Example delete application application-id -1000000

Output Failure shows an appropriate error message.

delete application
Description Database of user-defined URLs

Syntax delete application application-name <application-name>

Parameters

Parameter Description
Application name
application-name
Type: URL

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

Output Failure shows an appropriate error message.

delete application-group

User defined application group

delete application-group
Description User defined application group

Syntax delete application-group name <name>

Parameters

Parameter Description
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Command Line Interface Reference Guide R77.20 Embedded | 49


Example delete application-group name users

Output Failure shows an appropriate error message.

delete application-group
Description User defined application group

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

Parameters

Parameter Description
The ID of the application group
application-group-id
Type: A number with no fractional part (integer)

Example delete application-group application-group-id -1000000

Output Failure shows an appropriate error message.

delete bridge

Description Bridge configured in the device

Syntax delete bridge <name>

Parameters

Parameter Description
Bridge name
name
Type: A bridge name can be br0-9

Example delete bridge br7

Output Failure shows an appropriate error message.

delete dhcp server interface

Description Local network

Syntax delete dhcp server interface <name> exclude-range

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example delete dhcp server interface My_Network exclude-range

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 50


delete dns

Configure DNS and Domain settings for the device

delete dns
Description Configure DNS and Domain settings for the device

Syntax delete dns [ primary ipv4-address ]

Parameters There are no parameters

Example delete dns primary ipv4-address

Output Failure shows an appropriate error message.

delete dns
Description Configure DNS and Domain settings for the device

Syntax delete dns [ secondary ipv4-address ]

Parameters There are no parameters

Example delete dns secondary ipv4-address

Output Failure shows an appropriate error message.

delete dns
Description Configure DNS and Domain settings for the device

Syntax delete dns [ tertiary ipv4-address ]

Parameters There are no parameters

Example delete dns tertiary ipv4-address

Output Failure shows an appropriate error message.

delete dns
Description Configure DNS and Domain settings for the device

Syntax delete domainname

Parameters There are no parameters

Example delete domainname

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 51


delete group

Description Network Objects Group model

Syntax delete group <name>

Parameters

Parameter Description
Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example delete group myObject_17

Output Failure shows an appropriate error message.

delete host

Description Address range object

Syntax delete host <name>

Parameters

Parameter Description
Network Object name
name
Type: String

Example delete host TEXT

Output Failure shows an appropriate error message.

delete interface

Description Local network

Syntax delete interface <name>

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example delete interface My_Network

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 52


delete interface-loopback

Description Local network

Syntax delete interface-loopback <name>

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example delete interface-loopback My_Network

Output Failure shows an appropriate error message.

delete internet-connection

Internet Connection

delete internet-connection
Description Internet Connection

Syntax delete internet-connection <name>

Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Example delete internet-connection My connection

Output Failure shows an appropriate error message.

delete internet-connection
Description Internet Connection

Syntax delete internet-connection <name> probe-icmp-servers [ first ] [ second ] [


third ]

Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Example delete internet-connection My connection probe-icmp-servers first second


third

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 53


delete internet-connections

Description Internet Connection

Syntax delete internet-connections

Parameters There are no parameters

Example delete internet-connections

Output Failure shows an appropriate error message.

delete local-group

Local Users Group

delete local-group
Description Local Users Group

Syntax delete local-group name <name>

Parameters

Parameter Description
Local group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example delete local-group name myObject_17

Output Failure shows an appropriate error message.

delete local-group
Description Local Users Group

Syntax delete local-group all

Parameters There are no parameters

Example delete local-group all

Output Failure shows an appropriate error message.

delete local-user

Configure a local database of users

Command Line Interface Reference Guide R77.20 Embedded | 54


delete local-user
Description Configure a local database of users

Syntax delete local-user name <name>

Parameters

Parameter Description
User’s name in the local database
name
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Example delete local-user name admin

Output Failure shows an appropriate error message.

delete local-user
Description Configure a local database of users

Syntax delete local-user all

Parameters There are no parameters

Example delete local-user all

Output Failure shows an appropriate error message.

delete nat-rule

Description Manual NAT rules

Syntax delete nat-rule name <name>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them

Example delete nat-rule name word


Output Failure shows an appropriate error message.

delete nat-rule position

Description Manual NAT rules

Syntax delete nat-rule position <position>

Parameters

Parameter Description
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Command Line Interface Reference Guide R77.20 Embedded | 55


Example delete nat-rule position 2

Output Failure shows an appropriate error message.

delete netflow collector

Description Netflow object table

Syntax delete netflow collector ip <ip> port <port>

Parameters

Parameter Description
IP address
ip
Type: IP address
UDP port
port
Type: Port number

Example delete netflow collector ip 192.168.1.1 port 8080

Output Failure shows an appropriate error message.

delete network

Description Address range object

Syntax delete network <name>


Parameters

Parameter Description
Network Object name
name
Type: String

Example delete network TEXT

Output Failure shows an appropriate error message.

delete proxy

Description Configure proxy settings for connecting with Check Point update and license servers

Syntax delete proxy

Parameters There are no parameters

Example delete proxy

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 56


delete qos-rule

QoS rule base rule configuration

delete qos-rule
Description QoS rule base rule configuration

Syntax delete qos-rule idx <idx>

Parameters

Parameter Description
The order of the rule in comparison to other manual rules
idx
Type: Decimal number

Example delete qos-rule idx 3.141

Output Failure shows an appropriate error message.

delete qos-rule
Description QoS rule base rule configuration

Syntax delete qos-rule name <name>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them

Example delete qos-rule name word


Output Failure shows an appropriate error message.

delete radius-server

Description Users RADIUS server

Syntax delete radius-server priority <priority>

Parameters

Parameter Description
Priority of the choose tab, can be primary or secondary
priority
Type: A number with no fractional part (integer)

Example delete radius-server priority -1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 57


delete server

Description Server network object

Syntax delete server <name>

Parameters

Parameter Description
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example delete server myObject_17

Output Failure shows an appropriate error message.

delete service-group

Description A group of services

Syntax delete service-group <name>

Parameters

Parameter Description
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example delete service-group myObject_17

Output Failure shows an appropriate error message.

delete service-icmp

Description Service objects

Syntax delete service-icmp <name>

Parameters

Parameter Description
Service name
name
Type: String

Example delete service-icmp TEXT

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 58


delete service-protocol

Description Service objects

Syntax delete service-protocol <name>

Parameters

Parameter Description
Service name
name
Type: String

Example delete service-protocol TEXT

Output Failure shows an appropriate error message.

delete service-tcp

Description Service objects

Syntax delete service-tcp <name>

Parameters

Parameter Description
Service name
name
Type: String

Example delete service-tcp TEXT

Output Failure shows an appropriate error message.

delete service-udp

Description Service objects

Syntax delete service-udp <name>

Parameters

Parameter Description
Service name
name
Type: String

Example delete service-udp TEXT

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 59


delete snmp

Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of notifying the
manager that something is wrong

delete snmp
Description Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of
notifying the manager that something is wrong

Syntax delete snmp traps-receiver <traps-receiver>

Parameters

Parameter Description
Receivers IP address that the trap associated with
traps-receiver
Type: IP address

Example delete snmp traps-receiver 192.168.1.1

Output Failure shows an appropriate error message.

delete snmp
Description SNMP version3 user configuration options for: security level, authentication settings and passwords

Syntax delete snmp user <user>


Parameters

Parameter Description
version3 user name
user
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Example delete snmp user admin

Output Failure shows an appropriate error message.

delete snmp
Description SNMP general configuration options

Syntax delete snmp contact

Parameters There are no parameters

Example delete snmp contact

Output Failure shows an appropriate error message.

delete snmp
Description SNMP general configuration options

Command Line Interface Reference Guide R77.20 Embedded | 60


Syntax delete snmp location

Parameters There are no parameters

Example delete snmp location

Output Failure shows an appropriate error message.

delete snmp traps-receivers

Description Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of
notifying the manager that something is wrong

Syntax delete snmp traps-receivers all

Parameters There are no parameters

Example delete snmp traps-receivers all

Output Failure shows an appropriate error message.

delete snmp users

Description SNMP version3 user configuration options for: security level, authentication settings and passwords

Syntax delete snmp users all

Parameters There are no parameters

Example delete snmp users all

Output Failure shows an appropriate error message.

delete static-route

Description Static routes

Syntax delete static-route <id>

Parameters

Parameter Description
id
id
Type: A number with no fractional part (integer)

Example delete static-route -1000000


Output Failure shows an appropriate error message.

delete static-routes

Description Static routes

Command Line Interface Reference Guide R77.20 Embedded | 61


Syntax delete static-routes

Parameters There are no parameters

Example delete static-routes

Output Failure shows an appropriate error message.

delete streaming-engine-settings

Description Streaming engine settings

Syntax delete streaming-engine-settings

Parameters There are no parameters


Example delete streaming-engine-settings

Output Failure shows an appropriate error message.

delete switch

Description Switch

Syntax delete switch <name>

Parameters

Parameter Description
Name
name
Type: A switch name can be LAN[1-8]_Switch

Example delete switch LAN2_Switch

Output Failure shows an appropriate error message.

delete threat-prevention anti-virus file-type

Description Manage Anti-Virus policy per file type

Syntax delete threat-prevention anti-virus file-type extension <extension>

Parameters

Parameter Description
File extension that represents this file type
extension Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Example delete threat-prevention anti-virus file-type extension This is a comment.

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 62


delete threat-prevention anti-virus file-type custom

Description Manage Anti-Virus policy per file type

Syntax delete threat-prevention anti-virus file-type custom all

Parameters There are no parameters

Example delete threat-prevention anti-virus file-type custom all

Output Failure shows an appropriate error message.

delete threat-prevention exception

Description Malware exceptions

Syntax delete threat-prevention exception name <name>

Parameters

Parameter Description
The name of the exception
name
Type: A string of alphanumeric characters without space between them

Example delete threat-prevention exception name word

Output Failure shows an appropriate error message.

delete threat-prevention exception position

Description Malware exceptions

Syntax delete threat-prevention exception position <position>

Parameters

Parameter Description
The order of the rule in comparison to other rules
position
Type: Decimal number

Example delete threat-prevention exception position 2


Output Failure shows an appropriate error message.

delete threat-prevention exceptions

Description Malware exceptions


Syntax delete threat-prevention exceptions all
Parameters There are no parameters
Example delete threat-prevention exceptions all

Command Line Interface Reference Guide R77.20 Embedded | 63


Output Failure shows an appropriate error message.

delete threat-prevention ips network-exception

Configure exception rules to bypass IPS protections for specific traffic

delete threat-prevention ips network-exception


Description Configure exception rules to bypass IPS protections for specific traffic

Syntax delete threat-prevention ips network-exception position <position>

Parameters

Parameter Description
The order of the rule in the rule base
position
Type: Decimal number

Example delete threat-prevention ips network-exception position 2

Output Failure shows an appropriate error message.

delete threat-prevention ips network-exception


Description Configure exception rules to bypass IPS protections for specific traffic

Syntax delete threat-prevention ips network-exception all

Parameters There are no parameters


Example delete threat-prevention ips network-exception all

Output Failure shows an appropriate error message.

delete threat-prevention whitelist type-file

Threat prevention whitelist file

delete threat-prevention whitelist type-file


Description Threat prevention whitelist file

Syntax delete threat-prevention whitelist type-file md5 <md5>

Parameters

Parameter Description
MD5 encryption for the file in the whitelist
md5 Type: MD5 checksum of a file. Contains only [a-f] and [0-9] characters and of
exact length of 32

Command Line Interface Reference Guide R77.20 Embedded | 64


Example delete threat-prevention whitelist type-file md5 d41d8cd98f00b204e9800998ecf8427e

Output Failure shows an appropriate error message.

delete threat-prevention whitelist type-file


Description Threat prevention whitelist file

Syntax delete threat-prevention whitelist type-file all

Parameters There are no parameters

Example delete threat-prevention whitelist type-file all

Output Failure shows an appropriate error message.

delete threat-prevention whitelist type-url

Threat Prevention whitelist URL

delete threat-prevention whitelist type-url


Description Threat Prevention whitelist URL

Syntax delete threat-prevention whitelist type-url url <url>

Parameters

Parameter Description
URL
url
Type: URL

Example delete threat-prevention whitelist type-url url http://somehost.example.com

Output Failure shows an appropriate error message.

delete threat-prevention whitelist type-url


Description Threat Prevention whitelist URL

Syntax delete threat-prevention whitelist type-url all

Parameters There are no parameters

Example delete threat-prevention whitelist type-url all

Output Failure shows an appropriate error message.

delete ui-settings

Description Web Interface Settings and Customizations

Command Line Interface Reference Guide R77.20 Embedded | 65


Syntax delete ui-settings

Parameters There are no parameters

Example delete ui-settings

Output Failure shows an appropriate error message.

delete vpn

Description Local network

Syntax delete vpn tunnel <tunnel>

Parameters

Parameter Description
A number identifying the Virtual Tunnel Interface (VTI)
tunnel
Type: A number with no fractional part (integer)

Example delete vpn tunnel -1000000

Output Failure shows an appropriate error message.

delete vpn site

Configure remote VPN sites

delete vpn site


Description Configure remote VPN sites

Syntax delete vpn site name <name>

Parameters

Parameter Description
Site name
name Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example delete vpn site name site17

Output Failure shows an appropriate error message.

delete vpn site


Description Configure remote VPN sites

Syntax delete vpn site all

Parameters There are no parameters

Command Line Interface Reference Guide R77.20 Embedded | 66


Example delete vpn site all

Output Failure shows an appropriate error message.

delete wlan

Description Virtual Access Point

Syntax delete wlan vap <vap>

Parameters

Parameter Description
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example delete wlan vap My_Network


Output Failure shows an appropriate error message.

delete wlan vaps

Description Virtual Access Point


Syntax delete wlan vaps
Parameters There are no parameters
Example delete wlan vaps
Output Failure shows an appropriate error message.

fetch cloud-services policy

Description Cloud Services


Syntax fetch cloud-services policy
Parameters There are no parameters
Example fetch cloud-services policy
Output Failure shows an appropriate error message.

find application

Description Application
Syntax find application <application-name>
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 67


Parameter Description
Application or group name
application-name
Type: String

Example find application TEXT

Output Failure shows an appropriate error message.

find threat-prevention ips protection

Description IPS topic view

Syntax find threat-prevention ips protection <name>


Parameters

Parameter Description
The name of the IPS topic
name
Type: A string of alphanumeric characters without space between them

Example find threat-prevention ips protection word

Output Failure shows an appropriate error message.

reconnect cloud-services

Description Cloud Services


Syntax reconnect cloud-services

Parameters There are no parameters

Example reconnect cloud-services

Output Failure shows an appropriate error message.

send cloud-report

Description Cloud report

Syntax send cloud-report type <type>

Parameters

Parameter Description
The report type
type
Options: top-last-hour, top-last-day, top-last-week, top-last-month, 3d

Example send cloud-report type top-last-hour

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 68


set access-rule type incoming-internal-and-vpn

Firewall rule base

set access-rule type incoming-internal-and-vpn


Description Firewall rule base

Syntax set access-rule type incoming-internal-and-vpn position <position> [ action


<action> ] [ log <log> ] [ source <source> ] [ source-negate <source-negate>
] [ destination <destination> ] [ destination-negate <destination-negate> ] [
service <service> ] [ service-negate <service-negate> ] [ disabled <disabled>
] [ comment <comment> ] [ hours-range-enabled { true hours-range-from
<hours-range-from> hours-range-to <hours-range-to> | false } ] [ { position
<position> | position-above <position-above> | position-below <position-below>
} ] [ name <name> ] [ vpn <vpn> ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: block, accept, ask, inform, block-inform
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
Indicates if the rule is disabled
disabled
Type: Boolean (true/false)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
Defines which logging method to use: None - do not log, Log - Create log, Alert
log - log with alert, Account - account rule
Options: none, log, alert, account
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the source is all traffic except what is defined in the source field
source-negate
Type: Boolean (true/false)
Indicates if traffic is matched on encrypted traffic only or all traffic
vpn
Type: Boolean (true/false)

Example set access-rule type incoming-internal-and-vpn position 2 action block


log none source TEXT source-negate true destination TEXT destination-negate

Command Line Interface Reference Guide R77.20 Embedded | 69


true service TEXT service-negate true disabled true comment This is a comment.
hours-range-enabled true hours-range-from 23:20 hours-range-to 23:20 position
2 name word vpn true

Output Failure shows an appropriate error message.

set access-rule type incoming-internal-and-vpn


Description Firewall rule base

Syntax set access-rule type incoming-internal-and-vpn name <name> [ action <action>


] [ log <log> ] [ source <source> ] [ source-negate <source-negate> ] [
destination <destination> ] [ destination-negate <destination-negate> ] [
service <service> ] [ service-negate <service-negate> ] [ disabled <disabled>
] [ comment <comment> ] [ hours-range-enabled { true hours-range-from
<hours-range-from> hours-range-to <hours-range-to> | false } ] [ { position
<position> | position-above <position-above> | position-below <position-below>
} ] [ name <name> ] [ vpn <vpn> ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: block, accept, ask, inform, block-inform
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
Indicates if the rule is disabled
disabled
Type: Boolean (true/false)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
Defines which logging method to use: None - do not log, Log - Create log, Alert
log - log with alert, Account - account rule
Options: none, log, alert, account
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the source is all traffic except what is defined in the source field
source-negate
Type: Boolean (true/false)
Indicates if traffic is matched on encrypted traffic only or all traffic
vpn
Type: Boolean (true/false)

Example set access-rule type incoming-internal-and-vpn name word action block log

Command Line Interface Reference Guide R77.20 Embedded | 70


none source TEXT source-negate true destination TEXT destination-negate true
service TEXT service-negate true disabled true comment This is a comment.
hours-range-enabled true hours-range-from 23:20 hours-range-to 23:20 position
2 name word vpn true

Output Failure shows an appropriate error message.

set access-rule type outgoing

Firewall rule base

set access-rule type outgoing


Description Firewall rule base

Syntax set access-rule type outgoing position <position> [ action <action>


] [ log <log> ] [ source <source> ] [ source-negate <source-negate> ] [
destination <destination> ] [ destination-negate <destination-negate> ] [
service <service> ] [ service-negate <service-negate> ] [ disabled <disabled>
] [ comment <comment> ] [ hours-range-enabled { true hours-range-from
<hours-range-from> hours-range-to <hours-range-to> | false } ] [ {
position <position> | position-above <position-above> | position-below
<position-below> } ] [ name <name> ] [ { [ application-name <application-name>
] | [ application-id <application-id> ] } ] [ application-negate
<application-negate> ] [ limit-application-download { true limit <limit> |
false } ] [ limit-application-upload { true limit <limit> | false } ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: block, accept, ask, inform, block-inform
application-id Applications or web sites that are accepted or blocked
application-name Applications or web sites that are accepted or blocked
If true, the rule accepts or blocks all applications but the selected application
application-negate
Type: Boolean (true/false)
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
Indicates if the rule is disabled
disabled
Type: Boolean (true/false)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
Applications traffic upload limit (in kbps)
limit
Type: A number with no fractional part (integer)
If true, download is limited
limit-application-
Type: Boolean (true/false)
download

Command Line Interface Reference Guide R77.20 Embedded | 71


If true, upload is limited
limit-application-
Type: Boolean (true/false)
upload
Defines which logging method to use: None - do not log, Log - Create log, Alert
log - log with alert, Account - account rule
Options: none, log, alert, account
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the source is all traffic except what is defined in the source field
source-negate
Type: Boolean (true/false)

Example set access-rule type outgoing position 2 action block log none
source TEXT source-negate true destination TEXT destination-negate true
service TEXT service-negate true disabled true comment This is a comment.
hours-range-enabled true hours-range-from 23:20 hours-range-to 23:20
position 2 name word application-name hasOne application-negate true
limit-application-download true limit -1000000 limit-application-upload true
limit -1000000

Output Failure shows an appropriate error message.

set access-rule type outgoing


Description Firewall rule base
Syntax set access-rule type outgoing name <name> [ action <action> ] [ log
<log> ] [ source <source> ] [ source-negate <source-negate> ] [ destination
<destination> ] [ destination-negate <destination-negate> ] [ service
<service> ] [ service-negate <service-negate> ] [ disabled <disabled>
] [ comment <comment> ] [ hours-range-enabled { true hours-range-from
<hours-range-from> hours-range-to <hours-range-to> | false } ] [ {
position <position> | position-above <position-above> | position-below
<position-below> } ] [ name <name> ] [ { [ application-name <application-name>
] | [ application-id <application-id> ] } ] [ application-negate
<application-negate> ] [ limit-application-download { true limit <limit> |
false } ] [ limit-application-upload { true limit <limit> | false } ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: block, accept, ask, inform, block-inform
application-id Applications or web sites that are accepted or blocked
application-name Applications or web sites that are accepted or blocked
If true, the rule accepts or blocks all applications but the selected application
application-negate
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 72


Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
Indicates if the rule is disabled
disabled
Type: Boolean (true/false)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
Applications traffic upload limit (in kbps)
limit
Type: A number with no fractional part (integer)
If true, download is limited
limit-application-
Type: Boolean (true/false)
download
If true, upload is limited
limit-application-
Type: Boolean (true/false)
upload
Defines which logging method to use: None - do not log, Log - Create log, Alert
log - log with alert, Account - account rule
Options: none, log, alert, account
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the source is all traffic except what is defined in the source field
source-negate
Type: Boolean (true/false)

Example set access-rule type outgoing name word action block log none source
TEXT source-negate true destination TEXT destination-negate true service
TEXT service-negate true disabled true comment This is a comment.
hours-range-enabled true hours-range-from 23:20 hours-range-to 23:20
position 2 name word application-name hasOne application-negate true
limit-application-download true limit -1000000 limit-application-upload true
limit -1000000

Output Failure shows an appropriate error message.

set ad-server

Description Active directory server object

Syntax set ad-server <domain> [ ipv4-address <ipv4-address> ] [ username <username>


] [ password <password> ] [ user-dn <user-dn> ] [ use-branch-path { true [
branch-path <branch-path> ] | false } ]

Command Line Interface Reference Guide R77.20 Embedded | 73


Parameters

Parameter Description
The branch of the domain to be used
branch-path
Type: An LDAP DN
Domain name
domain
Type: Host name
ipv4-address Domain controller IP address
The user’s password
password
Type: A string that contains alphanumeric and special characters
Select only if you want to use only part of the user database defined in the Active
use-branch-path Directory
Type: Boolean (true/false)
FQDN of the user
user-dn
Type: An LDAP DN
A user name with administrator privileges to communicate with the AD server
username
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Example set ad-server myHost.com ipv4-address 192.168.1.1 username admin password


a(ˆ
&7Ba user-dn cn=John Doe,dc=example,dc=com use-branch-path true branch-path
cn=John Doe,dc=example,dc=com
Output Failure shows an appropriate error message.

set additional-hw-settings

Description Additional hardware and operating system settings

Syntax set additional-hw-settings [ reset-timeout <reset-timeout> ]

Parameters

Parameter Description
Indicates the amount of time (in seconds) that you need to press and hold the
reset-timeout factory defaults button on the back panel to restore to the factory defaults image
Type: A number with no fractional part (integer)

Example set additional-hw-settings reset-timeout -1000000

Output Failure shows an appropriate error message.

set address-range

Description Address range object

Syntax set address-range <name> [ name <name> ] [ start-ipv4 <start-ipv4> ] [


end-ipv4 <end-ipv4> ] [ dhcp-exclude-ip-addr <dhcp-exclude-ip-addr> ]

Parameters

Parameter Description
Indicates if the object’s IP address(es) is excluded from internal DHCP daemon
dhcp-exclude-ip-addr
Options: on, off
end-ipv4 The end of the IP range

Command Line Interface Reference Guide R77.20 Embedded | 74


Network Object name
name
Type: String
start-ipv4 The beginning of the IP range

Example set address-range TEXT name TEXT start-ipv4 192.168.1.1 end-ipv4


192.168.1.1 dhcp-exclude-ip-addr on

Output Failure shows an appropriate error message.

set admin-access

Description Administrator access

Syntax set admin-access [ interfaces { Wireless access <access> | VPN access


<access> | LAN access <access> | any access { allow | block } | WAN access
<access> } ] [ web-access-port <web-access-port> ] [ ssh-access-port
<ssh-access-port> ] [ allowed-ipv4-addresses <allowed-ipv4-addresses> ]

Parameters

Parameter Description
Enable administrator access from the Internet (clear traffic from external inter-
access faces)
Type: Boolean (true/false)
Administrator access permissions policy for source IP addresses
allowed-ipv4-
Options: any, from-ip-list, any-except-internet
addresses
SSH Port
ssh-access-port
Type: Port number
Web Port (HTTPS)
web-access-port
Type: Port number

Example set admin-access interfaces Wireless access true web-access-port 8080


ssh-access-port 8080 allowed-ipv4-addresses any

Output Failure shows an appropriate error message.

set administrator

Configured administrator for the appliance

set administrator
Description Configured administrator for the appliance
Syntax set administrator username <username> password

Parameters

Parameter Description
Indicates the administrator user name
username
Type: A string that contains [A-Z], [0-9], and ’_’ characters

Command Line Interface Reference Guide R77.20 Embedded | 75


Example set administrator username admin password

Output Failure shows an appropriate error message.

set administrator
Description Configured administrator for the appliance

Syntax set administrator username <username> permission <permission> [


password-hash <password-hash> ]

Parameters

Parameter Description
Virtual field used for calculating a hashed password
password-hash
Type: An encrypted password
Indicates if the administrator has read-only permissions
permission
Options: read-write, readonly
Indicates the administrator user name
username
Type: A string that contains [A-Z], [0-9], and ’_’ characters

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


TZXPLs20bN0RA

Output Failure shows an appropriate error message.

set administrator
Description Configured administrator for the appliance

Syntax set administrator username <username> password-hash <password-hash> [


permission <permission> ]

Parameters

Parameter Description
Virtual field used for calculating a hashed password
password-hash
Type: An encrypted password
Indicates if the administrator has read-only permissions
permission
Options: read-write, readonly
Indicates the administrator user name
username
Type: A string that contains [A-Z], [0-9], and ’_’ characters

Example set administrator username admin password-hash TZXPLs20bN0RA permission


read-write
Output Failure shows an appropriate error message.

set administrator session-settings

Description Limit administrators login failure attempts for before locking out for a defined period of time
Syntax set administrator session-settings [ lockout-enable <lockout-enable> ] [
max-lockout-attempts <max-lockout-attempts> ] [ lock-period <lock-period> ] [
inactivity-timeout <inactivity-timeout> ]

Command Line Interface Reference Guide R77.20 Embedded | 76


Parameters

Parameter Description
Allowed web interface session idle time before automatic logout is executed (in
inactivity-timeout minutes)
Type: A number with no fractional part (integer)
Once locked out, the administrator will be unable to login for this long
lock-period
Type: A number with no fractional part (integer)
Limit administrators login failure attempts
lockout-enable
Options: on, off
The maximum number of consecutive login failure attempts before the adminis-
max-lockout-attempts trator is locked out
Type: A number with no fractional part (integer)

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


-1000000 lock-period -1000000 inactivity-timeout -1000000

Output Failure shows an appropriate error message.

set administrators

Description Administrators RADIUS authentication

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


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

Parameters

Parameter Description
Administrators role
permission
Options: read-write, readonly
Administrators RADIUS authentication
radius-auth
Type: Boolean (true/false)
RADIUS groups for authentication. Example: RADIUS-group1, RADIUS-class2
radius-groups
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’, ’,’ and space characters
Use RADIUS groups for authentication
use-radius-groups
Type: Boolean (true/false)

Example set administrators radius-auth true use-radius-groups true radius-groups My


group permission read-write

Output Failure shows an appropriate error message.

set aggressive-aging

Connections aggressive aging

set aggressive-aging
Description Connections aggressive aging

Command Line Interface Reference Guide R77.20 Embedded | 77


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

Parameter Description
Connection table percentage limit
connt-limit-high-
Type: A number with no fractional part (integer)
watermark-pct
Memory consumption percentage limit
connt-mem-high-
Type: A number with no fractional part (integer)
watermark-pct
Enable aggressive aging of connections
general
Type: Boolean (true/false)
ICMP connections reduced timeout
icmp-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for ICMP connections
icmp-timeout-enable
Type: Boolean (true/false)
Tracking options for aggressive aging
log
Options: log, none
Choose when aggressive aging timeouts are enforced
memory-conn-status
Options: both, connections, memory
Other IP protocols reduced timeout
other-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for non TCP/UDP/ICMP connections
other-timeout-enable
Type: Boolean (true/false)
Pending Data connections reduced timeout
pending-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for non TCP/UDP/ICMP connections
pending-timeout-
Type: Boolean (true/false)
enable
TCP termination reduced timeout
tcp-end-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for TCP termination
tcp-end-timeout-
Type: Boolean (true/false)
enable
TCP handshake reduced timeout
tcp-start-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for TCP handshake
tcp-start-timeout-
Type: Boolean (true/false)
enable
TCP session reduced timeout
tcp-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for TCP session
tcp-timeout-enable
Type: Boolean (true/false)
UDP connections reduced timeout
udp-timeout
Type: A number with no fractional part (integer)
Enable reduced timeout for UDP connections
udp-timeout-enable
Type: Boolean (true/false)

Example set aggressive-aging icmp-timeout -1000000 icmp-timeout-enable true


other-timeout -1000000 other-timeout-enable true pending-timeout -1000000

Command Line Interface Reference Guide R77.20 Embedded | 78


pending-timeout-enable true tcp-end-timeout -1000000 tcp-end-timeout-enable
true tcp-start-timeout -1000000 tcp-start-timeout-enable true tcp-timeout
-1000000 tcp-timeout-enable true udp-timeout -1000000 udp-timeout-enable
true general true log log connt-limit-high-watermark-pct -1000000
connt-mem-high-watermark-pct -1000000 memory-conn-status both
Output Failure shows an appropriate error message.

set aggressive-aging
Description Connections aggressive aging

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 There are no 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.

set antispam

Policy for Anti-Spam blade

set antispam
Description 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> ]

Parameters

Parameter Description

Command Line Interface Reference Guide R77.20 Embedded | 79


Action to be used upon spam detection in email content: block, flag-header,
action-spam-email- flag-subject
content Options: block, flag-header, flag-subject
Detect-Only mode: on, off
detect-mode
Type: Boolean (true/false)
Type of spam detection: either Sender’s IP address or both Sender’s IP address
detection-method and content based detection
Options: email-content, sender-ipaddr-reputation-only
Text to add to spam e-mails subject (depends on action chosen for detected
flag-subject-stamp spam)
Type: A string of alphanumeric characters without space between them
Tracking options: log, alert or none
log
Options: none, log, alert
Anti-Spam blade mode: on, off
mode
Options: on, off

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


action-spam-email-content block flag-subject-stamp word detect-mode true

Output Failure shows an appropriate error message.

set antispam
Description Policy for Anti-Spam blade

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

Parameters There are no parameters

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

Output Failure shows an appropriate error message.

set antispam
Description Policy for Anti-Spam blade

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

Parameters There are no parameters

Example set antispam advanced-settings email-size-scan -1000000

Output Failure shows an appropriate error message.

set antispam
Description Policy for Anti-Spam blade
Syntax set antispam advanced-settings allow-mail-track <allow-mail-track>

Parameters There are no parameters

Example set antispam advanced-settings allow-mail-track none

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 80


set antispam
Description Policy for Anti-Spam blade

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

Parameters There are no parameters

Example set antispam advanced-settings transparent-proxy true

Output Failure shows an appropriate error message.

set antispam
Description Policy for Anti-Spam blade

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

Parameters There are no parameters

Example set antispam advanced-settings ip-rep-timeout -1000000


Output Failure shows an appropriate error message.

set antispam
Description Policy for Anti-Spam blade

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

Parameters There are no parameters

Example set antispam advanced-settings spam-engine-timeout -1000000


Output Failure shows an appropriate error message.

set antispam
Description Policy for Anti-Spam blade

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


<spam-engine-all-mail-track>
Parameters There are no parameters

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

Output Failure shows an appropriate error message.

set application

Database of user-defined URLs

Command Line Interface Reference Guide R77.20 Embedded | 81


set application
Description Database of user-defined URLs

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

Parameters

Parameter Description
Application name
application-name
Type: URL
url Application URL

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 Database of user-defined URLs
Syntax set application application-name <application-name> remove url <url>

Parameters

Parameter Description
Application name
application-name
Type: URL
url Application URL

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 Database of user-defined URLs

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

Parameters

Parameter Description
The ID of the application
application-id
Type: A number with no fractional part (integer)
url Application URL

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

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 82


set application
Description Database of user-defined URLs

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

Parameters

Parameter Description
The ID of the application
application-id
Type: A number with no fractional part (integer)
url Application URL

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

Output Failure shows an appropriate error message.

set application
Description Database of user-defined URLs

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

Parameters

Parameter Description
Application name
application-name
Type: URL
category Category name

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


TEXT
Output Failure shows an appropriate error message.

set application
Description Database of user-defined URLs

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


<category>

Parameters

Parameter Description
Application name
application-name
Type: URL
category Category name

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


category TEXT

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 83


set application
Description Database of user-defined URLs

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

Parameters

Parameter Description
The ID of the application
application-id
Type: A number with no fractional part (integer)
category Category name

Example set application application-id -1000000 add category TEXT

Output Failure shows an appropriate error message.

set application
Description Database of user-defined URLs

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

Parameters

Parameter Description
The ID of the application
application-id
Type: A number with no fractional part (integer)
category Category name

Example set application application-id -1000000 remove category TEXT

Output Failure shows an appropriate error message.

set application
Description Database of user-defined URLs

Syntax set application application-id <application-id> [ category <category> ] [


regex-url <regex-url> ]

Parameters

Parameter Description
The ID of the application
application-id
Type: A number with no fractional part (integer)
The primary category for the application (the category which is the most rele-
category
vant)
Indicates if regular expressions are used instead of partial strings
regex-url
Type: Boolean (true/false)

Example set application application-id -1000000 category TEXT regex-url true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 84


set application
Description Database of user-defined URLs

Syntax set application application-name <application-name> [ category <category> ]


[ regex-url <regex-url> ]

Parameters

Parameter Description
Application name
application-name
Type: URL
The primary category for the application (the category which is the most rele-
category
vant)
Indicates if regular expressions are used instead of partial strings
regex-url
Type: Boolean (true/false)

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


regex-url true

Output Failure shows an appropriate error message.

set application-control

Description Default APPI policy and configuration

Syntax set application-control [ mode <mode> ] [ 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

Parameter Description
Block file sharing using torrents and peer-to-peer applications
block-file-sharing-
Type: Boolean (true/false)
applications
Control content by blocking Internet access to websites with inappropriate con-
block-inappropriate- tent such as sex, violence, weapons, gambling, and alcohol
content Type: Boolean (true/false)
Manually add and block applications or categories of URLs to a group of unde-
block-other-undesired- sired applications
applications Type: Boolean (true/false)
Block applications and URLs that can be a security risk and are categorized as
block-security- spyware, phishing, botnet, spam, anonymizer, or hacking
categories Type: Boolean (true/false)
Indicates if applications that use a lot of bandwidth are limited (also used for
limit-bandwidth QoS)
Type: Boolean (true/false)
If true, traffic for downloading is limited to the value in maxLimitedDownload
limit-download
Type: Boolean (true/false)
If true, traffic for uploading is limited to the value in maxLimitedDownload
limit-upload
Type: Boolean (true/false)
Applications & URLs mode - true for on, false for off
mode
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 85


The limit, in kbps, for downloading
set-limit
Type: A number with no fractional part (integer)

Example set application-control mode 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 -1000000 limit-download true set-limit -1000000

Output Failure shows an appropriate error message.

set application-group

User defined application group

set application-group
Description User defined application group

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


Parameters

Parameter Description
application-name Application or group name
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Example set application-group name users add application-name hasMany

Output Failure shows an appropriate error message.

set application-group
Description User defined application group

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


Parameters

Parameter Description
application-name Application or group name
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Example set application-group name users remove application-name hasMany

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 86


set application-group
Description User defined application group

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

Parameters

Parameter Description
application-id The ID of the application or the group
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Example set application-group name users add application-id hasMany

Output Failure shows an appropriate error message.

set application-group
Description User defined application group
Syntax set application-group name <name> remove application-id <application-id>

Parameters

Parameter Description
application-id The ID of the application or the group
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Example set application-group name users remove application-id hasMany

Output Failure shows an appropriate error message.

set application-group
Description User defined application group

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


application-name <application-name>

Parameters

Parameter Description
The ID of the application group
application-group-id
Type: A number with no fractional part (integer)
application-name Application or group name

Example set application-group application-group-id -1000000 add application-name


hasMany

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 87


set application-group
Description User defined application group

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


application-name <application-name>

Parameters

Parameter Description
The ID of the application group
application-group-id
Type: A number with no fractional part (integer)
application-name Application or group name

Example set application-group application-group-id -1000000 remove application-name


hasMany

Output Failure shows an appropriate error message.

set application-group
Description User defined application group

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


application-id <application-id>
Parameters

Parameter Description
The ID of the application group
application-group-id
Type: A number with no fractional part (integer)
application-id The ID of the application or the group

Example set application-group application-group-id -1000000 add application-id


hasMany

Output Failure shows an appropriate error message.

set application-group
Description User defined application group

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


application-id <application-id>

Parameters

Parameter Description
The ID of the application group
application-group-id
Type: A number with no fractional part (integer)
application-id The ID of the application or the group

Example set application-group application-group-id -1000000 remove application-id


hasMany

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 88


set bridge

Bridge configured in the device

set bridge
Description Bridge configured in the device

Syntax set bridge <name> stp <stp>

Parameters

Parameter Description
Bridge name
name
Type: A bridge name can be br0-9
Spanning Tree Protocol mode
stp
Options: on, off

Example set bridge br7 stp on

Output Failure shows an appropriate error message.

set bridge
Description Bridge configured in the device

Syntax set bridge <name> add member <member>

Parameters

Parameter Description
member Network name
Bridge name
name
Type: A bridge name can be br0-9

Example set bridge br7 add member My_Network

Output Failure shows an appropriate error message.

set bridge
Description Bridge configured in the device

Syntax set bridge <name> remove member <member>

Parameters

Parameter Description
member Network name
Bridge name
name
Type: A bridge name can be br0-9

Example set bridge br7 remove member My_Network


Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 89


set cloud-deployment

Description Cloud Deployment Settings

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


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

Parameters

Parameter Description
The DNS or IP address through which the device will connect to the cloud ser-
cloud-url vice
Type: URL
Container
container
Type: String
The appliance name used to identify the gateway
gateway-name
Type: A string that contains [A-Z], [0-9] and ’-’ characters
Template
template
Type: String

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.

set cloud-services

Cloud Services

set cloud-services
Description Cloud Services

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

Parameter Description
A key received from the Cloud Services provider which is used to initialize the
activation-key connection to the Cloud Services
Type: String
Is the service center URL is a trusted certificate
confirm-untrusted-
Type: Boolean (true/false)
certificate
Gateway id (in the format <gateway name>.<portal name>). This is not needed
gateway-id if an activation-key was configured.
Type: A string of alphanumeric characters without space between them
Indicates if the device is managed by a cloud service
mode
Options: off, on
Registration key that acts as a password when connecting to the cloud service
registration-key for the first time. This is not needed if an activation-key was configured.
Type: A registration key

Command Line Interface Reference Guide R77.20 Embedded | 90


The DNS or IP address through which the device will connect to the cloud ser-
service-center vice for the first time. This is not needed if an activation-key was configured.
Type: URL

Example set cloud-services activation-key TEXT confirm-untrusted-certificate true


mode off

Output Failure shows an appropriate error message.

set cloud-services
Description Cloud Services

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 There are no 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.

set date

Manual time

set date
Description Manual time

Syntax set date <date>

Parameters

Parameter Description
Date in the format YYYY-MM-DD
date
Type: A date format yyyy-mm-dd

Example set date 2000-01-01

Output Failure shows an appropriate error message.

set date
Description Manual time

Syntax set time <time>

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 91


Parameter Description
Time in the format HH:MM
time
Type: A time format hh:mm

Example set time 23:20

Output Failure shows an appropriate error message.

set date
Description Manual time

Syntax set timezone <timezone>

Parameters

Parameter Description
timezone Timezone location

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

Output Failure shows an appropriate error message.

set date
Description Manual time

Syntax set timezone-dst automatic <timezone-dst automatic>

Parameters

Parameter Description
Automatic adjustment clock for daylight saving changes flag
timezone-dst auto-
Options: on, off
matic

Example set timezone-dst automatic on

Output Failure shows an appropriate error message.

set device-details

Description Device details

Syntax set device-details [ hostname <hostname> ] [ country <country> ]


Parameters

Parameter Description
The country where you are located. The country configured for the WLAN
country
Options: country
The appliance name used to identify the gateway.
hostname
Type: A string that contains [A-Z], [0-9] and ’-’ characters

Command Line Interface Reference Guide R77.20 Embedded | 92


Example set device-details hostname My-appliance country albania

Output Failure shows an appropriate error message.

set dhcp server interface

DHCP custom option

set dhcp server interface


Description DHCP custom option

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

Parameter Description
cliName
cliName
Type: virtual
Set the name of the object
custom-option name
Type: A string that contains alphanumeric characters or hyphen
Set the desired value of the object
data
Type: String
Select a unique tag for the object
tag
Type: A number with no fractional part (integer)
Select the appropriate type to store your object
type Options: string, int8, int16, int32, uint8, uint16, uint32, boolean, ipv4-address,
ipv4-address-array, hex-string

Example set dhcp server interface virtual custom-option name MyOption type string
tag -1000000 data TEXT

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
Use DHCP Server with a specified IP address range
dhcp
Options: off, on, relay
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network off

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 93


set dhcp server interface
Description Local network

Syntax set dhcp server interface <name> relay relay-to <relay relay-to> [ secondary
<secondary> ]

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
Enter the DHCP server IP address
relay relay-to
Type: IP address
Enter the secondary DHCP server IP address
secondary
Type: IP address

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 Local network

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

Parameters

Parameter Description
DHCP range
include-ip-pool
Type: A range of IP addresses
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

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 Local network
Syntax set dhcp server interface <name> exclude-ip-pool <exclude-ip-pool>

Parameters

Parameter Description
DHCP exclude range (IPv4 address range format)
exclude-ip-pool
Type: A range of IP addresses
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network exclude-ip-pool 192.168.1.1-192.168.1.10

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 94


set dhcp server interface
Description Local network

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

Parameters

Parameter Description
default-gateway A virtual field calculated by the values of the fields: dhcpGwMode & dhcpGw
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network default-gateway auto

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
wins-mode Configure the WINS Server

Example set dhcp server interface My_Network wins-mode auto

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
secondary Configure the IP address for the second WINS server
wins primary Configure the IP address for the first WINS server

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.

Command Line Interface Reference Guide R77.20 Embedded | 95


set dhcp server interface
Description Local network

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

Parameters

Parameter Description
Configure the timeout in hours for a single device to retain a dynamically ac-
lease-time
quired IP address
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network lease-time -1000000

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

Syntax set dhcp server interface <name> domain <domain>

Parameters

Parameter Description
domain The domain name of the DHCP
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network domain myHost.com

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
ntp Configure the first NTP (Network Time Protocol) server to be distributed to
DHCP client
secondary Configure the second NTP (Network Time Protocol) server to be distributed to
DHCP client

Example set dhcp server interface My_Network ntp 192.168.1.1 secondary 192.168.1.1

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 96


set dhcp server interface
Description Local network

Syntax set dhcp server interface <name> tftp <tftp>

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
tftp Configure TFTP server to be distributed to DHCP client

Example set dhcp server interface My_Network tftp 192.168.1.1

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

Syntax set dhcp server interface <name> file <file>

Parameters

Parameter Description
file Configure TFTP bootfile to be distributed to DHCP client
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network file word

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
callmgr Configure the first Call manager server to be distributed to DHCP client
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
secondary Configure the second Call manager server to be distributed to DHCP client

Example set dhcp server interface My_Network callmgr 192.168.1.1 secondary


192.168.1.1

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 97


set dhcp server interface
Description Local network

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

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
xwin-display-mgr Configure X-Windows display manager to be distributed to DHCP client

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 Local network

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

Parameters

Parameter Description
avaya-voip Configure Avaya IP phone to be distributed to DHCP client
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network avaya-voip TEXT

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
nortel-voip Configure Nortel IP phone to be distributed to DHCP client

Example set dhcp server interface My_Network nortel-voip TEXT


Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network
Syntax set dhcp server interface <name> thomson-voip <thomson-voip>

Command Line Interface Reference Guide R77.20 Embedded | 98


Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
thomson-voip Configure Thomson IP phone to be distributed to DHCP client

Example set dhcp server interface My_Network thomson-voip TEXT

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
dns Configure the DNS Server
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network dns auto

Output Failure shows an appropriate error message.

set dhcp server interface


Description Local network

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

Parameters

Parameter Description
dns primary Configure the IP address for the first DNS server
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

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 Local network

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

Parameters

Parameter Description
dns secondary Configure the IP address for the second DNS server

Command Line Interface Reference Guide R77.20 Embedded | 99


Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

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 Local network

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

Parameters

Parameter Description
dns tertiary Configure the IP address for the third DNS server
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

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 Local network

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

Parameters

Parameter Description
custom-option Set the name of the object
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set dhcp server interface My_Network remove custom-option MyOption

Output Failure shows an appropriate error message.

set dhcp-relay

Description DHCP Relay advanced options

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


<use-internal-ip-addrs-as-source>

Parameters There are no parameters

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

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 100


set dns

Configure DNS and Domain settings for the device

set dns
Description Configure DNS and Domain 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

Parameter Description
First global DNS IP address
primary ipv4-address
Type: IP address
Second global DNS IP address
secondary ipv4-
Type: IP address
address
Third global DNS IP address
tertiary ipv4-address
Type: IP address

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 Configure DNS and Domain settings for the device

Syntax set dns mode <mode>

Parameters

Parameter Description
Status of appliance using global DNS servers
mode
Options: global, internet

Example set dns mode global

Output Failure shows an appropriate error message.

set dns
Description Configure DNS and Domain settings for the device

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

Parameters

Parameter Description
Relay DNS requests from internal network clients to the DNS servers defined
proxy above
Type: Press TAB to see available options

Command Line Interface Reference Guide R77.20 Embedded | 101


Use network objects as a hosts list to translate names to their IP addresses
resolving
Options: on, off

Example set dns proxy on resolving on

Output Failure shows an appropriate error message.

set dns
Description Configure DNS and Domain settings for the device

Syntax set domainname <domainname>

Parameters

Parameter Description
Identification string that defines a realm of administrative autonomy, authority, or
domainname control in the Internet
Type: A FQDN

Example set domainname somehost.example.com

Output Failure shows an appropriate error message.

set dynamic-dns

Configure a persistent domain name for the device

set dynamic-dns
Description Configure a persistent domain name for the device

Syntax set dynamic-dns { enable } provider <provider> password <password> user


<user> domain <domain>

Parameters

Parameter Description
The domain name (sometimes called host name) within your account that the
domain device will use
Type: A FQDN
Is the DDNS service active
is-active
Type: Boolean (true/false)
The password of the account
password
Type: A string that contains alphanumeric and special characters
Select the DDNS provider that you have already set up an account with
provider
Options: no-ip.com, DynDns
The user name of the account
Type: DynDns provider: begins with a letter and have 2-25 alphanumeric char-
user
acters. no-ip.com provider: length is 6-15 characters and contains only a-z, 0-9,
-, _

Example set dynamic-dns true provider no-ip.com password a(ˆ


&7Ba user myUser17

Command Line Interface Reference Guide R77.20 Embedded | 102


domain somehost.example.com

Output Failure shows an appropriate error message.

set dynamic-dns
Description Configure a persistent domain name for the device

Syntax set dynamic-dns { disable }

Parameters

Parameter Description
Is the DDNS service active
is-active
Type: Boolean (true/false)

Example set dynamic-dns true

Output Failure shows an appropriate error message.

set dynamic-dns
Description Configure a persistent domain name for the device

Syntax set dynamic-dns provider <provider> [ password <password> ] [ user <user> ]


[ domain <domain> ]
Parameters

Parameter Description
The domain name (sometimes called host name) within your account that the
domain device will use
Type: A FQDN
The password of the account
password
Type: A string that contains alphanumeric and special characters
Select the DDNS provider that you have already set up an account with
provider
Options: no-ip.com, DynDns
The user name of the account
Type: DynDns provider: begins with a letter and have 2-25 alphanumeric char-
user
acters. no-ip.com provider: length is 6-15 characters and contains only a-z, 0-9,
-, _

Example set dynamic-dns provider no-ip.com password a(ˆ


&7Ba user myUser17 domain
somehost.example.com

Output Failure shows an appropriate error message.

set fw policy

Default policy for firewall blade

Command Line Interface Reference Guide R77.20 Embedded | 103


set fw policy
Description Default policy for firewall blade

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


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

Parameters

Parameter Description
mode Current mode for firewall policy
Indicates if accepted connections are logged
track-allowed-traffic
Options: none, log
Indicates if blocked connections are logged
track-blocked-traffic
Options: none, log

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 The activation modes for firewall

Syntax set fw policy add name <name>

Parameters

Parameter Description
name Service or service group name

Example set fw policy add name TEXT

Output Failure shows an appropriate error message.

set fw policy
Description The activation modes for firewall

Syntax set fw policy remove name <name>

Parameters

Parameter Description
name Service or service group name

Example set fw policy remove name TEXT

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 104


set fw policy user-check accept

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

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


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

Parameters

Parameter Description
The informative text that appears in the APPI ’Accept’ user message
body
Type: A string that contains only printable characters
Indicates the action to take when an ’Accept’ user message cannot be displayed
fallback-action
Options: block, accept
Indicates how often is the APPI ’Accept’ user message is being presented to the
frequency same user
Options: day, week, month
The subject of an APPI ’Accept’ user message
subject
Type: A string that contains only printable characters
The title of an APPI ’Accept’ user message
title
Type: A string that contains only printable characters

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 User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

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

Parameter Description
The informative text that appears in the APPI ’Ask’ user message
body
Type: A string that contains only printable characters
This text appears next to the ’ignore warning’ checkbox of an APPI ’Ask’ user
confirm-text message
Type: A string that contains only printable characters
The action that is performed when the ’Ask’ message cannot be shown
fallback-action
Options: block, accept
Indicates how often is the APPI ’Ask’ user message is being presented to the
frequency same user
Options: day, week, month
Indicates if the user must enter a reason for ignoring this message in a desig-
reason-displayed nated text dialog
Type: Boolean (true/false)
The subject of an APPI ’Ask’ user message
subject
Type: A string that contains only printable characters
The title of an APPI ’Ask’ user message
title
Type: A string that contains only printable characters

Command Line Interface Reference Guide R77.20 Embedded | 105


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 User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

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


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

Parameter Description
The informative text that appears in the APPI ’Block’ user message
body
Type: A string that contains only printable characters
Indicates if the user will be redirected to a custom URL in case of a ’Block’ action
redirect-to-url
Type: Boolean (true/false)
Indicates the URL to redirect the user in case of a ’Block’ action if configured
to do so. The URL to redirect the user in case of a ’Block’ action. Redirection
redirect-url
happens only if this functionality is turned on
Type: urlWithHttp
The subject of an APPI ’Block’ user message
subject
Type: A string that contains only printable characters
The title of an APPI ’Block’ user message
title
Type: A string that contains only printable characters

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.

set group

Network Objects Group model

set group
Description Network Objects Group model

Syntax set group <name> [ new-name <new-name> ] [ comments <comments> ]

Parameters

Parameter Description
Comments and explanation about the Network Object group
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Command Line Interface Reference Guide R77.20 Embedded | 106


Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Network Object group name
new-name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set group myObject_17 new-name myObject_17 comments This is a comment.

Output Failure shows an appropriate error message.

set group
Description Network Objects Group model

Syntax set group <name> remove-all members

Parameters

Parameter Description
Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set group myObject_17 remove-all members

Output Failure shows an appropriate error message.

set group
Description Network Objects Group model
Syntax set group <name> add member <member>

Parameters

Parameter Description
member Network Object name
Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set group myObject_17 add member TEXT

Output Failure shows an appropriate error message.

set group
Description Network Objects Group model
Syntax set group <name> remove member <member>

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 107


Parameter Description
member Network Object name
Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set group myObject_17 remove member TEXT

Output Failure shows an appropriate error message.

set host

Description Address range object

Syntax set host <name> [ name <name> ] [ dhcp-exclude-ip-addr { on [


dhcp-reserve-ip-addr-to-mac { on mac-addr <mac-addr> | off } ] | off } ] [
dns-resolving <dns-resolving> ] [ ipv4-address <ipv4-address> ]

Parameters

Parameter Description
Indicates if the object’s IP address(es) is excluded from internal DHCP daemon
dhcp-exclude-ip-addr
Type: Press TAB to see available options
Indicates if the IP address is reserved in internal DHCP daemon
dhcp-reserve-ip-addr-
Type: Press TAB to see available options
to-mac
Indicates if the name of the server/network object will be used as a hostname
dns-resolving for internal DNS service
Type: Boolean (true/false)
ipv4-address The beginning of the IP range
MAC address of the Network Object
mac-addr
Type: MAC address
Network Object name
name
Type: String

Example set host TEXT name TEXT dhcp-exclude-ip-addr on dhcp-reserve-ip-addr-to-mac


on mac-addr 00:1C:7F:21:05:BE dns-resolving true ipv4-address 192.168.1.1
Output Failure shows an appropriate error message.

set hotspot

Hotspot settings

set hotspot
Description Hotspot settings
Syntax set hotspot [ require-auth <require-auth> ] [ auth-mode <auth-mode> ]
[ allowed-group <allowed-group> ] [ timeout <timeout> ] [ portal-title
<portal-title> ] [ portal-msg <portal-msg> ] [ show-terms-of-use
<show-terms-of-use> ] [ terms-of-use <terms-of-use> ]

Command Line Interface Reference Guide R77.20 Embedded | 108


Parameters

Parameter Description
Indicates the specific user group that can authenticate through the hotspot when
allowed-group auth-mode is set to allow-specific-group
Type: A string of alphanumeric characters without space between them
Allow access to a specific user group only or all users
auth-mode
Options: allow-all, allow-specific-group
The message shown in hotspot portal
portal-msg
Type: A string that contains only printable characters
The title of the hotspot portal
portal-title
Type: A string that contains only printable characters
Indicates if user authentication is required
require-auth
Type: Boolean (true/false)
Indicates if a terms and conditions link will be shown in the hotspot portal
show-terms-of-use
Options: on, off
Indicates the When users will click the terms and conditions text shown in the
terms-of-use hotspot portal
Type: A string that contains only printable characters
Time, in minutes, untill the hotspot session expires
timeout
Type: A number with no fractional part (integer)

Example set hotspot require-auth true auth-mode allow-all allowed-group


word timeout -1000000 portal-title My Network portal-msg My Network
show-terms-of-use on terms-of-use My Network

Output Failure shows an appropriate error message.

set hotspot
Description Hotspot settings

Syntax set hotspot add exception <exception>

Parameters

Parameter Description
exception Network object name

Example set hotspot add exception TEXT

Output Failure shows an appropriate error message.

set hotspot
Description Hotspot settings

Syntax set hotspot remove exception <exception>

Parameters

Parameter Description
exception Network object name

Example set hotspot remove exception TEXT


Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 109


set hotspot
Description Hotspot settings

Syntax set hotspot advanced-settings activation <activation>

Parameters There are no parameters

Example set hotspot advanced-settings activation on

Output Failure shows an appropriate error message.

set https-categorization

HTTPS categorization

set https-categorization
Description HTTPS categorization

Syntax set https-categorization advanced-settings validate-cert-expiration


<validate-cert-expiration>

Parameters There are no parameters

Example set https-categorization advanced-settings validate-cert-expiration true

Output Failure shows an appropriate error message.

set https-categorization
Description HTTPS categorization

Syntax set https-categorization advanced-settings validate-unreachable-crl


<validate-unreachable-crl>

Parameters There are no parameters

Example set https-categorization advanced-settings validate-unreachable-crl true

Output Failure shows an appropriate error message.

set https-categorization
Description HTTPS categorization

Syntax set https-categorization advanced-settings validate-crl <validate-crl>

Parameters There are no parameters

Example set https-categorization advanced-settings validate-crl true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 110


set interface

Local network

set interface
Description Local network

Syntax set interface <name> ipv4-address <ipv4-address> { subnet-mask <subnet-mask>


default-gw <default-gw> [ dns-primary <dns-primary> [ dns-secondary
<dns-secondary> [ dns-tertiary <dns-tertiary> ] ] ] | mask-length
<mask-length> default-gw <default-gw> [ dns-primary <dns-primary> [
dns-secondary <dns-secondary> [ dns-tertiary <dns-tertiary> ] ] ] }

Parameters

Parameter Description
Default gateway
default-gw
Type: IP address
First DNS server IP address
dns-primary
Type: IP address
Second DNS server IP address
dns-secondary
Type: IP address
Third DNS server IP address
dns-tertiary
Type: IP address
The IP address
ipv4-address
Type: IP address
Subnet mask length
mask-length
Type: A string that contains numbers only
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
Subnet mask
subnet-mask
Type: Subnet mask

Example set interface My_Network ipv4-address 192.168.1.1 subnet-mask 255.255.255.0


default-gw 192.168.1.1 dns-primary 192.168.1.1 dns-secondary 192.168.1.1
dns-tertiary 192.168.1.1
Output Failure shows an appropriate error message.

set interface
Description Local network

Syntax set interface <name> ipv4-address <ipv4-address> { mask-length <mask-length>


| subnet-mask <subnet-mask> }

Parameters

Parameter Description
Enter the IP address of the interface
ipv4-address
Type: IP address
Represents the network’s mask length
mask-length
Type: A string that contains numbers only
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
Enter the Subnet mask of the specified network
subnet-mask
Type: A subnet mask, or 255.255.255.255

Command Line Interface Reference Guide R77.20 Embedded | 111


Example set interface My_Network ipv4-address 192.168.1.1 mask-length 20

Output Failure shows an appropriate error message.

set interface
Description Local network

Syntax set interface <name> unassigned

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set interface My_Network unassigned

Output Failure shows an appropriate error message.

set interface
Description Local network

Syntax set interface <name> [ auto-negotiation <auto-negotiation> ] [ mtu <mtu> ] [


link-speed <link-speed> ]

Parameters

Parameter Description
Enable this option in order to manually configure the link speed of the interface.
auto-negotiation
Options: on, off
Configure the link speed of the interface manually
link-speed
Options: 10/full, 10/half, 100/full, 100/half
Configure the Maximum Transmission Unit size for an interface
mtu
Type: A number with no fractional part (integer)
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set interface My_Network auto-negotiation on mtu -1000000 link-speed


10/full

Output Failure shows an appropriate error message.

set interface
Description Local network

Syntax set interface <name> state <state>

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
The mode of the network - enabled or disabled
state
Options: on, off

Command Line Interface Reference Guide R77.20 Embedded | 112


Example set interface My_Network state on

Output Failure shows an appropriate error message.

set interface
Description Local network

Syntax set interface <name> description <description>

Parameters

Parameter Description
Description
description Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set interface My_Network description This is a comment.

Output Failure shows an appropriate error message.

set interface
Description Local network
Syntax set interface <name> [ lan-access <lan-access> ] [ lan-access-track
<lan-access-track> ]

Parameters

Parameter Description
Local networks will be accessible from this network once this option is enabled
lan-access
Options: block, accept
Traffic from this network to local networks will be logged once this option is
lan-access-track enabled
Options: none, log
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set interface My_Network lan-access block lan-access-track none

Output Failure shows an appropriate error message.

set internet

Description Global settings that affect all internet connections

Syntax set internet advanced-settings reset-sierra-usb-on-lsi-event


<reset-sierra-usb-on-lsi-event>

Parameters There are no parameters

Example set internet advanced-settings reset-sierra-usb-on-lsi-event true

Command Line Interface Reference Guide R77.20 Embedded | 113


Output Failure shows an appropriate error message.

set internet mode

Description Traffic will be distributed automatically across the defined Internet connections according to the con-
figured load balancing weights

Syntax set internet mode { load-balancing | high-availability }

Parameters

Parameter Description
The load balancing mode
lb-mode
Options: on, off

Example set internet mode on

Output Failure shows an appropriate error message.

set internet-connection

Internet Connection

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> [ auto-negotiation <auto-negotiation> ] [


link-speed <link-speed> ] [ mtu <mtu> ] [ mac-addr <mac-addr> ] [ vpi <vpi> ]
[ vci <vci> ] [ standard <standard> ] [ encapsulation <encapsulation> ]

Parameters

Parameter Description
Disable auto negotiation and manually define negotiation link speed
auto-negotiation
Options: on, off
Encapsulation type for the ADSL connection
encapsulation
Options: llc, vcmux
Link speed
link-speed
Options: 100/full, 100/half, 10/full, 10/half
Default mac address wrapper
mac-addr
Type: A MAC address or ’default’
MTU size. Select ’default’ for default value.
mtu
Type: A string of alphanumeric characters without space between them
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
The ADSL standard to use
standard
Options: multimode, t1413, glite, gdmt, adsl2, adsl2+
VCI value for the ADSL connection
vci
Type: A number between 0 and 65535
VPI value for the ADSL connection
vpi
Type: A number between 0 and 4095

Command Line Interface Reference Guide R77.20 Embedded | 114


Example set internet-connection My connection auto-negotiation on link-speed
100/full mtu word mac-addr 00:1C:7F:21:05:BE vpi 42 vci 42 standard multimode
encapsulation llc

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> connect-on-demand <connect-on-demand>

Parameters

Parameter Description
Holds the status of the connect on demand feature
connect-on-demand
Type: Boolean (true/false)
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Example set internet-connection My connection connect-on-demand true

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> { enable | disable }

Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Connection enabled/disabled
state
Type: Boolean (true/false)

Example set internet-connection My connection true

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> qos-download { true [ bandwidth <bandwidth> ]


| false }

Parameters

Parameter Description
ISP download bandwidth
bandwidth
Type: A number with no fractional part (integer)
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Command Line Interface Reference Guide R77.20 Embedded | 115


Enable QoS(quality of service) restriction on inbound traffic(download)
qos-download
Type: Boolean (true/false)

Example set internet-connection My connection qos-download true bandwidth -1000000

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> qos-upload { true [ bandwidth <bandwidth> ] |


false }

Parameters

Parameter Description
ISP upload bandwidth
bandwidth
Type: A number with no fractional part (integer)
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Enable QoS(quality of service) restriction on outbound traffic(upload)
qos-upload
Type: Boolean (true/false)

Example set internet-connection My connection qos-upload true bandwidth -1000000

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> ha-priority <ha-priority>


load-balancing-weight <load-balancing-weight>

Parameters

Parameter Description
Priority of the connection in HA
ha-priority
Type: A number with no fractional part (integer)
Internet connection weight for load balancing configuration
load-balancing-weight
Type: A number with no fractional part (integer)
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Example set internet-connection My connection ha-priority -1000000


load-balancing-weight -1000000

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Command Line Interface Reference Guide R77.20 Embedded | 116


Syntax set internet-connection <name> route-traffic-through-default-gateway
<route-traffic-through-default-gateway>
Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
In order to route traffic through this connection you need to add specific routes
route-traffic-through- through it
default-gateway Type: Boolean (true/false)

Example set internet-connection My connection route-traffic-through-default-gateway


true
Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> type { static ipv4-address <ipv4-address>


{ subnet-mask <subnet-mask> | mask-length <mask-length> } default-gw
<default-gw> [ dns-primary <dns-primary> ] [ dns-secondary <dns-secondary>
] [ dns-tertiary <dns-tertiary> ] | pppoe username <username> {
password <password> | password-hash <password-hash> } | pptp username
<username> { password <password> | password-hash <password-hash> } server
<server> [ local-ipv4-address <local-ipv4-address> ] [ wan-ipv4-address
<wan-ipv4-address> { wan-subnet-mask <wan-subnet-mask> | wan-mask-length
<wan-mask-length> } default-gw <default-gw> ] | l2tp username <username>
{ password <password> | password-hash <password-hash> } server <server>
[ local-ipv4-address <local-ipv4-address> ] [ wan-ipv4-address
<wan-ipv4-address> { wan-subnet-mask <wan-subnet-mask> | wan-mask-length
<wan-mask-length> } default-gw <default-gw> ] }

Parameters

Parameter Description
WAN default gateway (in the advanced section of PPTP and l2TP)
default-gw
Type: IP address
First DNS server IP address
dns-primary
Type: IP address
Second DNS server IP address
dns-secondary
Type: IP address
Third DNS server IP address
dns-tertiary
Type: IP address
IP address field(for static ip and bridge settings)
ipv4-address
Type: IP address
Local tunnel IP address or Auto for automatic
local-ipv4-address
Type: An IP address, or ’auto’
Subnet mask length
mask-length
Type: A string that contains numbers only
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Password for PPP connection or cellular modem settings
password
Type: internetPassword
The hash of the user password
password-hash
Type: passwordHash

Command Line Interface Reference Guide R77.20 Embedded | 117


Server IP address
server
Type: IP address
Subnet mask
subnet-mask
Type: A subnet mask, or 255.255.255.255
Connection type
type
Type: Press TAB to see available options
User name for PPP connection or cellular modem settings
username Type: A string that contains all printable characters but a single or double quote-
like characters. Usually <username>@<ISP>
Wan IP address wrapper
wan-ipv4-address
Type: An IP address, or ’auto’
WAN subnet mask length
wan-mask-length
Type: A string that contains numbers only
WAN subnet mask(in the advanced section)
wan-subnet-mask
Type: Subnet mask

Example set internet-connection My connection type static ipv4-address 192.168.1.1


subnet-mask 255.255.255.0 default-gw 192.168.1.1 dns-primary 192.168.1.1
dns-secondary 192.168.1.1 dns-tertiary 192.168.1.1

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> type { pppoe [ local-ipv4-address


<local-ipv4-address> ] [ method <method> ] [ idle-time <idle-time> ] }

Parameters

Parameter Description
Disconnect idle time
idle-time
Type: A number with no fractional part (integer)
Local tunnel IP address or Auto for automatic
local-ipv4-address
Type: An IP address, or ’auto’
Authentication method
method
Options: auto, pap, chap
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Connection type
type
Type: Press TAB to see available options

Example set internet-connection My connection type pppoe local-ipv4-address auto


method auto idle-time -1000000
Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection
Syntax set internet-connection <name> type { pppoa username <username> { password
<password> | password-hash <password-hash> } | eoa }
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 118


Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Password for PPP connection or cellular modem settings
password
Type: internetPassword
The hash of the user password
password-hash
Type: passwordHash
Connection type
type
Type: Press TAB to see available options
User name for PPP connection or cellular modem settings
username Type: A string that contains all printable characters but a single or double quote-
like characters. Usually <username>@<ISP>

Example set internet-connection My connection type pppoa username MyUsername@MyISP


password internetPassword

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> type { pppoa local-ipv4-address


<local-ipv4-address> [ method <method> ] [ idle-time <idle-time> ] | eoa [
wan-ipv4-address <wan-ipv4-address> { wan-subnet-mask <wan-subnet-mask> |
wan-mask-length <wan-mask-length> } default-gw <default-gw> ] }

Parameters

Parameter Description
WAN default gateway (in the advanced section of PPTP and l2TP)
default-gw
Type: IP address
Disconnect idle time
idle-time
Type: A number with no fractional part (integer)
Local tunnel IP address or Auto for automatic
local-ipv4-address
Type: An IP address, or ’auto’
Authentication method
method
Options: auto, pap, chap
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Connection type
type
Type: Press TAB to see available options
Wan IP address wrapper
wan-ipv4-address
Type: An IP address, or ’auto’
WAN subnet mask length
wan-mask-length
Type: A string that contains numbers only
WAN subnet mask(in the advanced section)
wan-subnet-mask
Type: Subnet mask

Example set internet-connection My connection type pppoa local-ipv4-address auto


method auto idle-time -1000000
Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Command Line Interface Reference Guide R77.20 Embedded | 119


Syntax set internet-connection <name> type { cellular number <number> [ username
<username> { password <password> | password-hash <password-hash> } ] [ apn
<apn> ] }

Parameters

Parameter Description
APN (cellular modem settings)
apn
Type: A string that contains [a-z], [0-9], ’-’ and ’.’ characters
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Dialed number of the cellular modem settings
number
Type: A sequence of numbers and #,* characters
Password for PPP connection or cellular modem settings
password
Type: internetPassword
The hash of the user password
password-hash
Type: passwordHash
Connection type
type
Type: Press TAB to see available options
User name for PPP connection or cellular modem settings
username Type: A string that contains all printable characters but a single or double quote-
like characters. Usually <username>@<ISP>

Example set internet-connection My connection type cellular number 758996 username


MyUsername@MyISP password internetPassword apn my-apn

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> probe-next-hop <probe-next-hop> [


probe-servers <probe-servers> ]

Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Automatically detect loss of connectivity to the default gateway
probe-next-hop
Type: Boolean (true/false)
Monitor connection state by sending probe packets to one or more servers on
probe-servers the Internet
Type: Boolean (true/false)

Example set internet-connection My connection probe-next-hop true probe-servers


true

Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> probe-next-hop <probe-next-hop> [


probing-method <probing-method> ]

Command Line Interface Reference Guide R77.20 Embedded | 120


Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Automatically detect loss of connectivity to the default gateway
probe-next-hop
Type: Boolean (true/false)
Connection probing method
probing-method
Options: icmp, dns

Example set internet-connection My connection probe-next-hop true probing-method


icmp
Output Failure shows an appropriate error message.

set internet-connection
Description Internet Connection

Syntax set internet-connection <name> { probe-icmp-servers } first <first> [ second


<second> ] [ third <third> ]

Parameters

Parameter Description
First IP address for the probing method(when using connection monitoring)
first
Type: An IP address or host name
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters
Connection probing method
probing-method
Options: icmp, dns
Second IP address for the probing method(when using connection monitoring)
second
Type: An IP address or host name
Third IP address for the probing method(when using connection monitoring)
third
Type: An IP address or host name

Example set internet-connection My connection icmp first myHost.com second


myHost.com third myHost.com
Output Failure shows an appropriate error message.

set ip-fragments-params

IP fragments parameters

set ip-fragments-params
Description IP fragments parameters
Syntax set ip-fragments-params advanced-settings minsize <minsize>
Parameters There are no parameters
Example set ip-fragments-params advanced-settings minsize -1000000
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 121


set ip-fragments-params
Description IP fragments parameters

Syntax set ip-fragments-params advanced-settings config [ track <track> ] [ limit


<limit> ] [ advanced-state <advanced-state> ] [ timeout <timeout> ] [ pkt-cap
<pkt-cap> ]

Parameters There are no parameters

Example set ip-fragments-params advanced-settings config track none limit -1000000


advanced-state forbid timeout -1000000 pkt-cap true

Output Failure shows an appropriate error message.

set ips engine-settings

IPS engine settings

set ips engine-settings


Description IPS engine settings

Syntax set ips engine-settings [ protection-scope <protection-scope>


] [ bypass-under-load { true [ bypass-track <bypass-track> ] [
gateway-load-thresholds [ cpu-usage-low-watermark <cpu-usage-low-watermark>
] [ cpu-usage-high-watermark <cpu-usage-high-watermark> ] [
memory-usage-low-watermark <memory-usage-low-watermark> ] [
memory-usage-high-watermark <memory-usage-high-watermark> ] [
threshold-detection-delay <threshold-detection-delay> ] ] | false } ]

Parameters

Parameter Description
Indicates how the appliance will track events where the bypass mechanism is
bypass-track activated/deactivated
Options: none, log, alert
Indicates if the IPS engine will move to bypass mode if the appliance is under
bypass-under-load heavy load
Type: Boolean (true/false)
Indicates if the IPS blade will protect internal networks only or protect all net-
protection-scope works (including external networks)
Options: protect-internal-hosts-only, perform-ips-inspection-on-all-traffic

Example set ips engine-settings protection-scope protect-internal-hosts-only


bypass-under-load true bypass-track none gateway-load-thresholds
cpu-usage-low-watermark -1000000 cpu-usage-high-watermark -1000000
memory-usage-low-watermark -1000000 memory-usage-high-watermark -1000000
threshold-detection-delay -1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 122


set ips engine-settings
Description IPS engine settings

Syntax set ips engine-settings advanced-settings AboutConfigIPSErrorPageConfig [


status-code-desc <status-code-desc> ] [ show-error-code <show-error-code> ] [
logo-url <logo-url> ] [ send-detailed-status-code <send-detailed-status-code>
] [ enable-logo-url <enable-logo-url> ]

Parameters There are no parameters

Example set ips engine-settings advanced-settings AboutConfigIPSErrorPageConfig


status-code-desc This is a comment. show-error-code true logo-url
http://www.checkpoint.com/ send-detailed-status-code true enable-logo-url true

Output Failure shows an appropriate error message.

set ips engine-settings


Description IPS engine settings
Syntax set ips engine-settings advanced-settings AboutConfigIPSErrorPage [
send-error-code <send-error-code> ] [ error-page-for-supported-web-protections
<error-page-for-supported-web-protections> ] [ url <url> ]

Parameters There are no parameters


Example set ips engine-settings advanced-settings AboutConfigIPSErrorPage
send-error-code true error-page-for-supported-web-protections do-not-show url
http://www.checkpoint.com/

Output Failure shows an appropriate error message.

set local-group

Description Local Users Group

Syntax set local-group name <name> [ new-name <new-name> ] [ comments <comments> ]


[ remote-access-on <remote-access-on> ]

Parameters

Parameter Description
Comments
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Local group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Local group name
new-name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Indicates if the users group have remote access permissions
remote-access-on
Type: Boolean (true/false)

Example set local-group name myObject_17 new-name myObject_17 comments This is a


comment. remote-access-on true

Command Line Interface Reference Guide R77.20 Embedded | 123


Output Failure shows an appropriate error message.

set local-group users

Local Users Group

set local-group users


Description Local Users Group

Syntax set local-group users name <name> add user-name <user-name>

Parameters

Parameter Description
Local group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
user-name User’s name in the local database

Example set local-group users name myObject_17 add user-name admin

Output Failure shows an appropriate error message.

set local-group users


Description Local Users Group
Syntax set local-group users name <name> remove user-name <user-name>

Parameters

Parameter Description
Local group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
user-name User’s name in the local database

Example set local-group users name myObject_17 remove user-name admin

Output Failure shows an appropriate error message.

set local-user

Description Configure a local database of users

Syntax set local-user name <name> [ new-name <new-name> ] [ { password-hash


<password-hash> | password <password> } ] [ comments <comments> ] [
remote-access-always-on <remote-access-always-on> ] [ is-temp-user { true
expiration-date <expiration-date> [ expiration-time <expiration-time> ] |
false } ]

Command Line Interface Reference Guide R77.20 Embedded | 124


Parameters

Parameter Description
Comments
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Expiration date for a temporary user in format yyyy-mm-dd
expiration-date
Type: A date format yyyy-mm-dd
Expiration time for a temporary user in format HH:MM
expiration-time
Type: A time format hh:mm
Indicates if the user entry is temporary
is-temp-user
Type: Boolean (true/false)
User’s name in the local database
name
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces
User’s name in the local database
new-name
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces
User’s password in the local database
password
Type: A string that contains alphanumeric and special characters
User’s hashed password (used for importing database)
password-hash
Type: An encrypted password
Always enable remote access permission for user
remote-access-
Type: Boolean (true/false)
always-on

Example set local-user name admin new-name admin password-hash TZXPLs20bN0RA


comments This is a comment. remote-access-always-on true is-temp-user true
expiration-date 2000-01-01 expiration-time 23:20

Output Failure shows an appropriate error message.

set log-servers-configuration

Description Log servers configuration

Syntax set log-servers-configuration mgmt-server-ip-addr <mgmt-server-ip-addr>


[ log-server-ip-addr <log-server-ip-addr> ] sic-name <sic-name>
one-time-password <one-time-password> [ external-log-server-enable
<external-log-server-enable> ]

Parameters

Parameter Description
Determine if an external log server is active
external-log-server-
Type: Boolean (true/false)
enable
This IP address is used if the log server is not located on the Security Manage-
log-server-ip-addr ment Server.
Type: IP address
This IP address is used for establishing trusted communication between the
mgmt-server-ip-addr Check Point Appliance and the log server.
Type: IP address
SIC one time password
one-time-password
Type: A string that contains alphanumeric and special characters
Enter the SIC name of the log server object that was defined in SmartDashboard
sic-name
Type: A SIC name

Example set log-servers-configuration mgmt-server-ip-addr 192.168.1.1


log-server-ip-addr 192.168.1.1 sic-name QWEDFRGH4 one-time-password a(ˆ
&7Ba

Command Line Interface Reference Guide R77.20 Embedded | 125


external-log-server-enable true

Output Failure shows an appropriate error message.

set loginMessages

Description loginMessages

Syntax set loginMessages <type> { on | off } [ line ] [ message <message> ]

Parameters

Parameter Description
enabled
enabled
Type: Boolean (true/false)
message
message
Type: virtual
type
type
Options: motd, banner, caption

Example set loginMessages motd true line message virtual

Output Failure shows an appropriate error message.

set nat

NAT global

set nat
Description NAT global

Syntax set nat [ hide-internal-networks <hide-internal-networks> ]

Parameters

Parameter Description
Hide internal networks behind the Gateway’s external IP address
hide-internal-networks
Type: Boolean (true/false)

Example set nat hide-internal-networks true


Output Failure shows an appropriate error message.

set nat
Description NAT global
Syntax set nat advanced-settings nat-destination-client-side <nat-destination-client-side>
Parameters There are no parameters
Example set nat advanced-settings nat-destination-client-side true

Command Line Interface Reference Guide R77.20 Embedded | 126


Output Failure shows an appropriate error message.

set nat
Description NAT global

Syntax set nat advanced-settings arp-proxy-merge <arp-proxy-merge>

Parameters There are no parameters

Example set nat advanced-settings arp-proxy-merge true

Output Failure shows an appropriate error message.

set nat
Description NAT global

Syntax set nat advanced-settings address-trans <address-trans>

Parameters There are no parameters

Example set nat advanced-settings address-trans true

Output Failure shows an appropriate error message.

set nat
Description NAT global

Syntax set nat advanced-settings nat-automatic-arp <nat-automatic-arp>

Parameters There are no parameters

Example set nat advanced-settings nat-automatic-arp true

Output Failure shows an appropriate error message.

set nat
Description NAT global

Syntax set nat advanced-settings nat-destination-client-side-manual


<nat-destination-client-side-manual>

Parameters There are no parameters

Example set nat advanced-settings nat-destination-client-side-manual true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 127


set nat
Description NAT global
Syntax set nat advanced-settings nat-hash-size <nat-hash-size>
Parameters There are no parameters
Example set nat advanced-settings nat-hash-size -1000000
Output Failure shows an appropriate error message.

set nat
Description NAT global
Syntax set nat advanced-settings nat-cache-num-entries <nat-cache-num-entries>
Parameters There are no parameters
Example set nat advanced-settings nat-cache-num-entries -1000000
Output Failure shows an appropriate error message.

set nat
Description NAT global
Syntax set nat advanced-settings nat-limit <nat-limit>
Parameters There are no parameters
Example set nat advanced-settings nat-limit -1000000
Output Failure shows an appropriate error message.

set nat
Description NAT global
Syntax set nat advanced-settings increase-hide-capacity <increase-hide-capacity>
Parameters There are no parameters
Example set nat advanced-settings increase-hide-capacity true
Output Failure shows an appropriate error message.

set nat
Description NAT global
Syntax set nat advanced-settings nat-cache-expiration <nat-cache-expiration>
Parameters There are no parameters
Example set nat advanced-settings nat-cache-expiration -1000000
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 128


set nat
Description NAT global

Syntax set nat advanced-settings perform-cluster-hide-fold <perform-cluster-hide-fold>

Parameters There are no parameters

Example set nat advanced-settings perform-cluster-hide-fold true

Output Failure shows an appropriate error message.

set nat
Description NAT global

Syntax set nat advanced-settings ip-pool-nat [ ip-pool-securemote


<ip-pool-securemote> ] [ ip-pool-log <ip-pool-log> ] [ ip-pool-per-interface
<ip-pool-per-interface> ] [ ip-pool-override-hide <ip-pool-override-hide>
] [ ip-pool-gw2Gw <ip-pool-gw2Gw> ] [ ip-pool-unused-return-interval
<ip-pool-unused-return-interval> ] [ log-ip-pool-allocation
<log-ip-pool-allocation> ] [ ip-pool-mode <ip-pool-mode> ] [
ip-pool-alloc-per-destination <ip-pool-alloc-per-destination> ]

Parameters There are no parameters

Example set nat advanced-settings ip-pool-nat ip-pool-securemote true ip-pool-log


none ip-pool-per-interface true ip-pool-override-hide true ip-pool-gw2Gw
true ip-pool-unused-return-interval -1000000 log-ip-pool-allocation none
ip-pool-mode do-not-use-IP-pool-NAT ip-pool-alloc-per-destination true

Output Failure shows an appropriate error message.

set nat-rule

Description Manual NAT rules

Syntax set nat-rule name <name> [ original-source <original-source> ]


[ original-destination <original-destination> ] [ original-service
<original-service> ] [ translated-source <translated-source> ] [
translated-destination <translated-destination> ] [ translated-service
<translated-service> ] [ comment <comment> ] [ hide-sources <hide-sources> ] [
enable-arp-proxy <enable-arp-proxy> ] [ { position <position> | position-above
<position-above> | position-below <position-below> } ] [ name <name> ] [
disabled <disabled> ]

Parameters

Parameter Description
Comment for manual NAT rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Indicates if rule is disabled
disabled
Type: Boolean (true/false)
The gateway will reply to ARP requests sent to the original destination’s IP ad-
enable-arp-proxy dress (Does not apply to IP ranges/networks)
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 129


Hide multiple sources behind the translated source addresses
hide-sources
Type: Boolean (true/false)
name
name
Type: A string of alphanumeric characters without space between them
original-destination Original destination of rule
original-service Original service of rule
original-source Original source of rule
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
translated-destination Translated destination of rule
translated-service Translated service of rule
translated-source Translated source of rule

Example set nat-rule name word original-source TEXT original-destination TEXT


original-service TEXT translated-source TEXT translated-destination TEXT
translated-service TEXT comment This is a comment. hide-sources true
enable-arp-proxy true position 2 name word disabled true

Output Failure shows an appropriate error message.

set nat-rule position

Description Manual NAT rules

Syntax set nat-rule position <position> [ original-source <original-source>


] [ original-destination <original-destination> ] [ original-service
<original-service> ] [ translated-source <translated-source> ] [
translated-destination <translated-destination> ] [ translated-service
<translated-service> ] [ comment <comment> ] [ hide-sources <hide-sources> ] [
enable-arp-proxy <enable-arp-proxy> ] [ { position <position> | position-above
<position-above> | position-below <position-below> } ] [ name <name> ] [
disabled <disabled> ]

Parameters

Parameter Description
Comment for manual NAT rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Indicates if rule is disabled
disabled
Type: Boolean (true/false)
The gateway will reply to ARP requests sent to the original destination’s IP ad-
enable-arp-proxy dress (Does not apply to IP ranges/networks)
Type: Boolean (true/false)
Hide multiple sources behind the translated source addresses
hide-sources
Type: Boolean (true/false)
name
name
Type: A string of alphanumeric characters without space between them
original-destination Original destination of rule
original-service Original service of rule
original-source Original source of rule

Command Line Interface Reference Guide R77.20 Embedded | 130


The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
translated-destination Translated destination of rule
translated-service Translated service of rule
translated-source Translated source of rule

Example set nat-rule position 2 original-source TEXT original-destination TEXT


original-service TEXT translated-source TEXT translated-destination TEXT
translated-service TEXT comment This is a comment. hide-sources true
enable-arp-proxy true position 2 name word disabled true

Output Failure shows an appropriate error message.

set netflow collector

Description Netflow object table

Syntax set netflow collector for-ip <for-ip> for-port <for-port> [ ip <ip> ] [ port
<port> ] [ export-format <export-format> ] [ srcaddr <srcaddr> ] [ is-enabled
<is-enabled> ]

Parameters

Parameter Description
Export format
export-format
Options: Netflow_V9, Netflow_V5
IP address
for-ip
Type: IP address
UDP port
for-port
Type: Port number
IP address
ip
Type: IP address
Indicates if netflow is enabled
is-enabled
Type: Boolean (true/false)
UDP port
port
Type: Port number
Source IP address
srcaddr
Type: IP address

Example set netflow collector for-ip 192.168.1.1 for-port 8080 ip 192.168.1.1 port
8080 export-format Netflow_V9 srcaddr 192.168.1.1 is-enabled true

Output Failure shows an appropriate error message.

set network

Description Address range object

Command Line Interface Reference Guide R77.20 Embedded | 131


Syntax set network <name> [ name <name> ] [ network-ipv4-address
<network-ipv4-address> ] { [ subnet-mask <subnet-mask> ] | [ mask-length
<mask-length> ] }

Parameters

Parameter Description
mask-length Mask length
Network Object name
name
Type: String
network-ipv4-address Network address
subnet-mask IP mask used in the related network

Example set network TEXT name TEXT network-ipv4-address 172.16.10.0 subnet-mask


255.255.255.0

Output Failure shows an appropriate error message.

set ntp

NTP

set ntp
Description NTP
Syntax set ntp [ local-time-zone <local-time-zone> ] [ auto-adjust-daylight-saving
<auto-adjust-daylight-saving> ]

Parameters

Parameter Description
Auto daylight
auto-adjust-daylight-
Options: on, off
saving
local-time-zone Region on earth that has a uniform standard time

Example set ntp local-time-zone GMT-11:00(Midway-Island) auto-adjust-daylight-saving


on

Output Failure shows an appropriate error message.

set ntp
Description NTP

Syntax set ntp active <active>

Parameters

Parameter Description
Region on earth that has a uniform standard time
active
Options: on, off

Command Line Interface Reference Guide R77.20 Embedded | 132


Example set ntp active on

Output Failure shows an appropriate error message.

set ntp
Description NTP

Syntax set ntp interval <interval>

Parameters

Parameter Description
Time interval (minutes) to update date and time settings from the NTP server
interval
Type: A number with no fractional part (integer)

Example set ntp interval -1000000

Output Failure shows an appropriate error message.

set ntp
Description NTP

Syntax set ntp auth { on secret-id <secret-id> secret <secret> | off }

Parameters

Parameter Description
Authentication with NTP servers flag
auth
Type: Press TAB to see available options
Key string for authentication with the NTP servers
secret
Type: A string that contains alphanumeric and special characters
Authentication key identifier
secret-id Type: A number with no fractional part. Values are between -
4,503,599,627,370,495 to 4,503,599,627,370,495

Example set ntp auth on secret-id -1000000 secret a(ˆ


&7Ba

Output Failure shows an appropriate error message.

set ntp server

NTP

set ntp server


Description NTP
Syntax set ntp server primary <primary>

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 133


Parameter Description
Primary NTP server
primary
Type: An IP address or host name

Example set ntp server primary myHost.com

Output Failure shows an appropriate error message.

set ntp server


Description NTP
Syntax set ntp server secondary <secondary>

Parameters

Parameter Description
Secondary NTP server
secondary
Type: An IP address or host name

Example set ntp server secondary myHost.com

Output Failure shows an appropriate error message.

set proxy

Configure proxy settings for connecting with Check Point update and license servers

set proxy
Description Configure proxy settings for connecting with Check Point update and license servers

Syntax set proxy server <server> port <port>

Parameters

Parameter Description
The proxy port
port
Type: Port number
The proxy Host name or IP address
server
Type: An IP address or host name

Example set proxy server myHost.com port 8080

Output Failure shows an appropriate error message.

set proxy
Description Configure proxy settings for connecting with Check Point update and license servers

Syntax set proxy { enable | disable }

Command Line Interface Reference Guide R77.20 Embedded | 134


Parameters

Command Line Interface Reference Guide R77.20 Embedded | 135


Parameter Description
A proxy server between the appliance and the Internet. This proxy server will
be used when the applianceŠs internal processes must reach a Check Point
use-proxy
server.
Type: Boolean (true/false)

Example set proxy true

Output Failure shows an appropriate error message.

set qos

QoS blade basic configuration

set qos
Description QoS blade basic configuration

Syntax set qos mode <mode>


Parameters

Parameter Description
Indicates if QoS blade is enabled
mode
Type: Boolean (true/false)

Example set qos mode true


Output Failure shows an appropriate error message.

set qos
Description QoS blade basic configuration
Syntax set qos default-policy [ limit-bandwidth-consuming-applications { true [
limit-upload-traffic <limit-upload-traffic> ] [ upload-limit <upload-limit>
] [ limit-download-traffic <limit-download-traffic> ] [ download-limit
<download-limit> ] | false } ] [ guarantee-bandwidth-to-configured-traffic
<guarantee-bandwidth-to-configured-traffic> [ guarantee-bandwidth-percentage
<guarantee-bandwidth-percentage> ] [ guarantee-bandwidth-traffic
<guarantee-bandwidth-traffic> ] [ guarantee-bandwidth-on-services
<guarantee-bandwidth-on-services> ] ] [ ensure-low-latency-for-delay-sensitive-services
<ensure-low-latency-for-delay-sensitive-services> ]
Parameters There are no parameters
Example set qos default-policy limit-bandwidth-consuming-applications true
limit-upload-traffic true upload-limit -1000000 limit-download-traffic
true download-limit -1000000 guarantee-bandwidth-to-configured-traffic on
guarantee-bandwidth-percentage -1000000 guarantee-bandwidth-traffic vpn
guarantee-bandwidth-on-services all ensure-low-latency-for-delay-sensitive-services
on
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 136


set qos
Description QoS blade basic configuration

Syntax set qos low-latency-traffic maximum-percentage-of-bandwidth


<maximum-percentage-of-bandwidth>

Parameters There are no parameters

Example set qos low-latency-traffic maximum-percentage-of-bandwidth -1000000

Output Failure shows an appropriate error message.

set qos
Description QoS blade basic configuration

Syntax set qos advanced-settings qos-logging <qos-logging>

Parameters There are no parameters


Example set qos advanced-settings qos-logging true

Output Failure shows an appropriate error message.

set qos delay-sensitive-service

A group of services

set qos delay-sensitive-service


Description A group of services

Syntax set qos delay-sensitive-service add service <service>

Parameters

Parameter Description
service Service name

Example set qos delay-sensitive-service add service TEXT

Output Failure shows an appropriate error message.

set qos delay-sensitive-service


Description A group of services

Syntax set qos delay-sensitive-service remove service <service>

Parameters

Parameter Description
service Service name

Command Line Interface Reference Guide R77.20 Embedded | 137


Example set qos delay-sensitive-service remove service TEXT

Output Failure shows an appropriate error message.

set qos guarantee-bandwidth-selected-services

A group of services

set qos guarantee-bandwidth-selected-services


Description A group of services

Syntax set qos guarantee-bandwidth-selected-services add service <service>

Parameters

Parameter Description
service Service name

Example set qos guarantee-bandwidth-selected-services add service TEXT

Output Failure shows an appropriate error message.

set qos guarantee-bandwidth-selected-services


Description A group of services
Syntax set qos guarantee-bandwidth-selected-services remove service <service>

Parameters

Parameter Description
service Service name

Example set qos guarantee-bandwidth-selected-services remove service TEXT


Output Failure shows an appropriate error message.

set qos-rule

QoS rule base rule configuration

set qos-rule
Description QoS rule base rule configuration
Syntax set qos-rule idx <idx> [ source <source> ] [ destination <destination>
] [ service <service> ] [ { [ low-latency-rule { normal [ limit-bandwidth
<limit-bandwidth> [ limit-percentage <limit-percentage> ] ] [
guarantee-bandwidth <guarantee-bandwidth> [ guarantee-percentage

Command Line Interface Reference Guide R77.20 Embedded | 138


<guarantee-percentage> ] ] | low } ] | [ limit-bandwidth <limit-bandwidth>
[ limit-percentage <limit-percentage> ] ] [ guarantee-bandwidth
<guarantee-bandwidth> [ guarantee-percentage <guarantee-percentage> ] ] }
] [ weight <weight> ] [ log <log> ] [ comment <comment> ] [ vpn <vpn> ] [
hours-range-enabled { true hours-range-from <hours-range-from> hours-range-to
<hours-range-to> | false } ] [ diffserv-mark { true diffserv-mark-val
<diffserv-mark-val> | false } ] [ name <name> ] [ { position <position> |
position-above <position-above> | position-below <position-below> } ] [
disabled <disabled> ]

Parameters

Parameter Description
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
DiffServ Mark is a way to mark connections so a third party will handle it. To use
diffserv-mark this option, your ISP or private WAN must support DiffServ
Type: Boolean (true/false)
To mark packets that will be given priority on the public network according to
their DSCP, select DiffServ Mark (1-63) and select a value. You can get the
diffserv-mark-val
DSCP value from your ISP or private WAN administrator
Type: A number with no fractional part (integer)
Indicates if rule is disabled
disabled
Type: Boolean (true/false)
If true, traffic guarantee is defined
guarantee-bandwidth
Type: Boolean (true/false)
Traffic guarantee percentage
guarantee-percentage
Type: A number with no fractional part (integer)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
The order of the rule in comparison to other manual rules
idx
Type: Decimal number
If true, traffic limit is defined
limit-bandwidth
Type: Boolean (true/false)
Traffic limit percentage
limit-percentage
Type: A number with no fractional part (integer)
Defines which logging method to use: None - do not log, Log - Create log
log
Options: none, log
The latency of the rule (low or normal)
low-latency-rule
Type: Press TAB to see available options
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
source Network object or user group that initiates the connection
Indicates if traffic is matched on encrypted traffic only or all traffic
vpn
Type: Boolean (true/false)
Traffic weight, relative to the weights defined for other rules
weight
Type: A number with no fractional part (integer)

Command Line Interface Reference Guide R77.20 Embedded | 139


Example set qos-rule idx 3.141 source TEXT destination TEXT service TEXT
low-latency-rule normal limit-bandwidth true limit-percentage -1000000
guarantee-bandwidth true guarantee-percentage -1000000 weight -1000000
log none comment This is a comment. vpn true hours-range-enabled
true hours-range-from 23:20 hours-range-to 23:20 diffserv-mark true
diffserv-mark-val -1000000 name word position 2 disabled true

Output Failure shows an appropriate error message.

set qos-rule
Description QoS rule base rule configuration

Syntax set qos-rule name <name> [ source <source> ] [ destination <destination>


] [ service <service> ] [ { [ low-latency-rule { normal [ limit-bandwidth
<limit-bandwidth> [ limit-percentage <limit-percentage> ] ] [
guarantee-bandwidth <guarantee-bandwidth> [ guarantee-percentage
<guarantee-percentage> ] ] | low } ] | [ limit-bandwidth <limit-bandwidth>
[ limit-percentage <limit-percentage> ] ] [ guarantee-bandwidth
<guarantee-bandwidth> [ guarantee-percentage <guarantee-percentage> ] ] }
] [ weight <weight> ] [ log <log> ] [ comment <comment> ] [ vpn <vpn> ] [
hours-range-enabled { true hours-range-from <hours-range-from> hours-range-to
<hours-range-to> | false } ] [ diffserv-mark { true diffserv-mark-val
<diffserv-mark-val> | false } ] [ name <name> ] [ { position <position> |
position-above <position-above> | position-below <position-below> } ] [
disabled <disabled> ]

Parameters

Parameter Description
Description of the rule
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
DiffServ Mark is a way to mark connections so a third party will handle it. To use
diffserv-mark this option, your ISP or private WAN must support DiffServ
Type: Boolean (true/false)
To mark packets that will be given priority on the public network according to
their DSCP, select DiffServ Mark (1-63) and select a value. You can get the
diffserv-mark-val
DSCP value from your ISP or private WAN administrator
Type: A number with no fractional part (integer)
Indicates if rule is disabled
disabled
Type: Boolean (true/false)
If true, traffic guarantee is defined
guarantee-bandwidth
Type: Boolean (true/false)
Traffic guarantee percentage
guarantee-percentage
Type: A number with no fractional part (integer)
If true, time is configured
hours-range-enabled
Type: Boolean (true/false)
Time in the format HH:MM
hours-range-from
Type: A time format hh:mm
Time in the format HH:MM
hours-range-to
Type: A time format hh:mm
If true, traffic limit is defined
limit-bandwidth
Type: Boolean (true/false)
Traffic limit percentage
limit-percentage
Type: A number with no fractional part (integer)
Defines which logging method to use: None - do not log, Log - Create log
log
Options: none, log

Command Line Interface Reference Guide R77.20 Embedded | 140


The latency of the rule (low or normal)
low-latency-rule
Type: Press TAB to see available options
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number
The order of the rule in comparison to other manual rules
position-above
Type: Decimal number
The order of the rule in comparison to other manual rules
position-below
Type: Decimal number
service The network service object that the rule should match to
source Network object or user group that initiates the connection
Indicates if traffic is matched on encrypted traffic only or all traffic
vpn
Type: Boolean (true/false)
Traffic weight, relative to the weights defined for other rules
weight
Type: A number with no fractional part (integer)

Example set qos-rule name word source TEXT destination TEXT service TEXT
low-latency-rule normal limit-bandwidth true limit-percentage -1000000
guarantee-bandwidth true guarantee-percentage -1000000 weight -1000000
log none comment This is a comment. vpn true hours-range-enabled
true hours-range-from 23:20 hours-range-to 23:20 diffserv-mark true
diffserv-mark-val -1000000 name word position 2 disabled true

Output Failure shows an appropriate error message.

set radius-server

Description Users RADIUS server

Syntax set radius-server priority <priority> [ ipv4-address <ipv4-address> ] [


udp-port <udp-port> ] [ shared-secret <shared-secret> ] [ timeout <timeout>
]

Parameters

Parameter Description
The IP address of the RADIUS server
ipv4-address
Type: IP address
Priority of the choose tab, can be primary or secondary
priority
Type: A number with no fractional part (integer)
Pre-shared secret between the RADIUS server and the Appliance
shared-secret
Type: A string that contains alphanumeric and special characters
A timeout value in seconds for communication with the RADIUS server
timeout
Type: A number with no fractional part (integer)
The port number through which the RADIUS server communicates with clients.
udp-port The default is 1812
Type: A number with no fractional part (integer)

Example set radius-server priority -1000000 ipv4-address 192.168.1.1 udp-port


-1000000 shared-secret a(ˆ
&7Ba timeout -1000000
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 141


set reach-my-device

Reach My Device

set reach-my-device
Description Reach My Device

Syntax set reach-my-device mode <mode>

Parameters

Parameter Description
Reach my device mode - true for on, false for off
mode
Type: Boolean (true/false)

Example set reach-my-device mode true

Output Failure shows an appropriate error message.

set reach-my-device
Description Reach My Device

Syntax set reach-my-device host-name <host-name> [ existing-host-name


<existing-host-name> ]

Parameters

Parameter Description
claimOccupiedName
existing-host-name
Type: Boolean (true/false)
Gateway Host name (DNS Prefix)
host-name
Type: A string of alphanumeric characters without space between them

Example set reach-my-device host-name word existing-host-name true


Output Failure shows an appropriate error message.

set reach-my-device
Description Reach My Device
Syntax set reach-my-device advanced-settings ignore-ssl-cert <ignore-ssl-cert>
Parameters There are no parameters
Example set reach-my-device advanced-settings ignore-ssl-cert true
Output Failure shows an appropriate error message.

set reach-my-device
Description Reach My Device

Command Line Interface Reference Guide R77.20 Embedded | 142


Syntax set reach-my-device advanced-settings reach-my-device-server-addr
<reach-my-device-server-addr>
Parameters There are no parameters

Example set reach-my-device advanced-settings reach-my-device-server-addr


http://www.checkpoint.com/

Output Failure shows an appropriate error message.

set remote-access users

Description VPN Remote Access

Syntax set remote-access users radius-auth { true [ use-radius-groups { true


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

Parameters

Parameter Description
Remote users RADIUS authentication
radius-auth
Type: Boolean (true/false)
RADIUS groups for authentication. Example: RADIUS-group1, RADIUS-class2
radius-groups
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’, ’,’ and space characters
Use RADIUS groups for authentication
use-radius-groups
Type: Boolean (true/false)

Example set remote-access users radius-auth true use-radius-groups true


radius-groups My group
Output Failure shows an appropriate error message.

set security-management

Description Security management settings

Syntax set security-management mode <mode>

Parameters

Parameter Description
Indicates whether the appliance is managed locally or centrally using a Check
mode Point management server
Options: locally-managed, centrally-managed

Example set security-management mode locally-managed

Output Failure shows an appropriate error message.

set serial-port

Serial port

Command Line Interface Reference Guide R77.20 Embedded | 143


set serial-port
Description Serial port

Syntax set serial-port [ port-speed <port-speed> ] [ flow-control <flow-control> ]


[ disabled <disabled> ] [ mode <mode> ]

Parameters

Parameter Description
disabled Indicates if the serial port is disabled
flow-control Indicates the method of data flow control to and from the serial port
Indicates if the serial port is used to connect to the appliance’s console, a remote
mode telnet server or allow a remote telnet connection to the device connected to the
serial port.
port-speed Indicates the port speed (Baud Rate) of the serial connection

Example set serial-port port-speed 9600 flow-control rts-cts disabled on mode


console

Output Failure shows an appropriate error message.

set serial-port
Description Serial port

Syntax set serial-port passive-mode [ tcp-port <tcp-port> ] [ allow-implicitly


<allow-implicitly> ]

Parameters There are no parameters

Example set serial-port passive-mode tcp-port 8080 allow-implicitly true

Output Failure shows an appropriate error message.

set serial-port
Description Serial port
Syntax set serial-port active-mode [ tcp-port <tcp-port> ] [ primary-server-address
<primary-server-address> ] [ secondary-server-address <secondary-server-address>
]

Parameters There are no parameters

Example set serial-port active-mode tcp-port 8080 primary-server-address myHost.com


secondary-server-address myHost.com

Output Failure shows an appropriate error message.

set server server-access

Description Server network object

Command Line Interface Reference Guide R77.20 Embedded | 144


Syntax set server server-access <name> [ access-zones { blocked [
trusted-zone-lan <trusted-zone-lan> ] [ trusted-zone-vpn-users
<trusted-zone-vpn-users> ] [ trusted-zone-trusted-wireless-networks
<trusted-zone-trusted-wireless-networks> ] [ trusted-zone-dmz
<trusted-zone-dmz> ] [ trusted-zone-vpn-sites <trusted-zone-vpn-sites>
] | allowed } ] [ allow-ping-to-server <allow-ping-to-server> ] [
log-blocked-connections <log-blocked-connections> ] [ log-accepted-connections
<log-accepted-connections> ]
Parameters

Parameter Description
Zones the server is accessible from by default (accept all by default, accept
only from configured zones, or define no server-specific default access policy).
access-zones
Manual policy rules will override this policy.
Type: Press TAB to see available options
indicates of default access policy will work on ICMP traffic as well as defined
allow-ping-to-server ports. This option will not work on multiple ports hidden behind the gateway.
Type: Boolean (true/false)
Indicates if connections that are accepted by the default access policy to the
log-accepted- server are logged
connections Options: none, log
Indicates if connections that are blocked by the default access policy to the
log-blocked- server are logged
connections Options: none, log
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Indicates if traffic from the DMZ network to the server is allowed or blocked by
trusted-zone-dmz default
Options: blocked, allowed
Indicates if traffic from Physical internal networks (LAN ports) to the server is
trusted-zone-lan allowed or blocked by default
Options: blocked, allowed
Indicates if traffic from trusted wireless networks to the server is allowed or
trusted-zone-trusted- blocked by default
wireless-networks Options: blocked, allowed
Indicates if encrypted traffic from remote VPN sites to the server is allowed or
trusted-zone-vpn-sites blocked by default
Options: blocked, allowed
Indicates if encrypted traffic from VPN remote access users to the server is
trusted-zone-vpn- allowed or blocked by default
users Options: blocked, allowed

Example set server server-access myObject_17 access-zones blocked trusted-zone-lan


blocked trusted-zone-vpn-users blocked trusted-zone-trusted-wireless-networks
blocked trusted-zone-dmz blocked trusted-zone-vpn-sites blocked
allow-ping-to-server true log-blocked-connections none log-accepted-connections
none

Output Failure shows an appropriate error message.

set server server-nat-settings

Description Server network object

Command Line Interface Reference Guide R77.20 Embedded | 145


Syntax set server server-nat-settings <name> [ nat-settings { static-nat [
static-nat-ipv4-address <static-nat-ipv4-address> ] [ static-nat-for-outgoing-traffic
<static-nat-for-outgoing-traffic> ] | port-forwarding } ] [
port-address-translation <port-address-translation> ] [ port-address-translation-external
<port-address-translation-external-port> ] [ force-source-hide-nat
<force-source-hide-nat > ]

Parameters

Parameter Description
Allow access from internal networks to the external IP address of the server via
force-source-hide-nat local switch
Type: Boolean (true/false)
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Indicates the general NAT settings configured (no NAT, hide behind the gate-
nat-settings way’s external IP address or use a different external IP address)
Type: Press TAB to see available options
For servers with a single port, indicates if the external port is not the same as
port-address- the internal port.
translation Type: Boolean (true/false)
For servers with a single port, indicates the external port that is used to forward
port-address- traffic to the server
translation-external- Type: Port number
port
indicates if outgoing traffic from the server using static NAT will be hidden behind
static-nat-for- the configured external IP address without a port change
outgoing-traffic Type: Boolean (true/false)
For servers using static NAT, the external IP address used to forward traffic to
static-nat-ipv4- the server
address Type: IP address

Example set server server-nat-settings myObject_17 nat-settings static-nat


static-nat-ipv4-address 192.168.1.1 static-nat-for-outgoing-traffic true
port-address-translation true port-address-translation-external-port 8080
force-source-hide-nat true

Output Failure shows an appropriate error message.

set server server-network-settings

Description Server network object

Syntax set server server-network-settings <name> [ name <name> ] [


dhcp-exclude-ip-addr { on [ dhcp-reserve-ip-addr-to-mac { on mac-addr
<mac-addr> | off } ] | off } ] [ comments <comments> ] [ dns-resolving
<dns-resolving> ] [ ipv4-address <ipv4-address> ]

Parameters

Parameter Description
Comments
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Command Line Interface Reference Guide R77.20 Embedded | 146


Indicates if the internal DHCP service will not distribute the configured IP ad-
dhcp-exclude-ip-addr dress of this server/network object to anyone
Type: Press TAB to see available options
Indicates if the internal DHCP service will distribute the configured IP address
dhcp-reserve-ip-addr- only to this server/network object according to its MAC address
to-mac Type: Press TAB to see available options
Indicates if the name of the server/network object will be used as a hostname
dns-resolving for internal DNS service
Type: Boolean (true/false)
ipv4-address The beginning of the IP range
MAC address of the server
mac-addr
Type: MAC address
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set server server-network-settings myObject_17 name myObject_17


dhcp-exclude-ip-addr on dhcp-reserve-ip-addr-to-mac on mac-addr
00:1C:7F:21:05:BE comments This is a comment. dns-resolving true ipv4-address
192.168.1.1

Output Failure shows an appropriate error message.

set server server-ports

Description Server network object

Syntax set server server-ports <name> [ web-server { true service-http { true


[ service-http-ports <service-http-ports> ] | false } service-https {
true [ service-https-ports <service-https-ports> ] | false } | false
} ] [ mail-server { true service-smtp { true [ service-smtp-ports
<service-smtp-ports> ] | false } service-pop3 { true [ service-pop3-ports
<service-pop3-ports> ] | false } service-imap { true [ service-imap-ports
<service-imap-ports> ] | false } | false } ] [ dns-server { true service-dns
{ true [ service-dns-porst <service-dns-porst> ] | false } | false } ] [
ftp-server { true service-ftp { true [ service-ftp-ports <service-ftp-ports>
] | false } | false } ] [ citrix-server { true service-citrix { true [
service-citrix-ports <service-citrix-ports> ] | false } | false } ] [
pptp-server { true service-pptp-selected { true [ service-pptp-ports
<service-pptp-ports> ] | false } | false } ] [ custom-server { true [
tcpProtocol <tcpProtocol> [ tcp-ports <tcp-ports> ] udpProtocol <udpProtocol>
[ udp-ports <udp-ports> ] ] | false } ]

Parameters

Parameter Description
citrix-server Indicates a Citrix server (for each type we provide default but configurable ports)
custom-server Server type custom
dns-server Indicates a DNS server (for each type we provide default but configurable ports)
ftp-server Indicates a FTP server (for each type we provide default but configurable ports)
mail-server Indicates a mail server (for each type we provide default but configurable ports)
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Command Line Interface Reference Guide R77.20 Embedded | 147


Indicates a PPTP server (for each type we provide default but configurable
pptp-server
ports)
service-citrix Indicates if ports are defined for Citrix (for a Citrix server)
service-citrix-ports Configured ports for Citrix (for a Citrix server)
service-dns Indicates if ports are defined for DNS (for a DNS server)
service-dns-porst Configured ports for DNS (for a DNS server)
service-ftp Indicates if ports are defined for FTP (for a FTP server)
service-ftp-ports Configured ports for FTP (for a FTP server)
service-http Indicates if ports are defined for HTTP (for a web server)
service-http-ports Configured ports for HTTP (for a web server)
service-https Indicates if ports are defined for HTTPS (for a web server)
service-https-ports Configured ports for HTTPS (for a web server)
service-imap Indicates if ports are defined for IMAP (for a mail server)
service-imap-ports Configured ports for IMAP (for a web server)
service-pop3 Indicates if ports are defined for POP3 (for a mail server)
service-pop3-ports Configured ports for POP3 (for a web server)
service-pptp-ports Configured ports for PPTP (for a PPTP server)
service-pptp-selected Indicates if ports are defined for PPTP (for a PPTP server)
service-smtp Indicates if ports are defined for SMTP (for a mail server)
service-smtp-ports Configured ports for SMTP (for a web server)
TCP ports for server of type ’other’
tcp-ports
Type: Port range
tcpProtocol
tcpProtocol
Type: Boolean (true/false)
UDP ports for server of type ’other’
udp-ports
Type: Port range
udpProtocol
udpProtocol
Type: Boolean (true/false)
web-server Indicates a web server (for each type we provide default but configurable ports)

Example set server server-ports myObject_17 web-server true service-http true


service-http-ports 8080-8090 service-https true service-https-ports 8080-8090
mail-server true service-smtp true service-smtp-ports 8080-8090 service-pop3
true service-pop3-ports 8080-8090 service-imap true service-imap-ports
8080-8090 dns-server true service-dns true service-dns-porst 8080-8090
ftp-server true service-ftp true service-ftp-ports 8080-8090 citrix-server
true service-citrix true service-citrix-ports 8080-8090 pptp-server true
service-pptp-selected true service-pptp-ports 8080-8090 custom-server true
tcpProtocol true tcp-ports 8080-8090 udpProtocol true udp-ports 8080-8090
Output Failure shows an appropriate error message.

set service-group

A group of services

set service-group
Description A group of services
Syntax set service-group <name> [ new-name <new-name> ] [ comments <comments> ]
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 148


Parameter Description
Comments and explanation about the Service Group
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces
Service Group name
new-name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set service-group myObject_17 new-name myObject_17 comments This is a


comment.

Output Failure shows an appropriate error message.

set service-group
Description A group of services

Syntax set service-group <name> remove-all members

Parameters

Parameter Description
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set service-group myObject_17 remove-all members

Output Failure shows an appropriate error message.

set service-group
Description A group of services

Syntax set service-group <name> add member <member>

Parameters

Parameter Description
member Service name
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set service-group myObject_17 add member TEXT


Output Failure shows an appropriate error message.

set service-group
Description A group of services

Command Line Interface Reference Guide R77.20 Embedded | 149


Syntax set service-group <name> remove member <member>

Parameters

Parameter Description
member Service name
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example set service-group myObject_17 remove member TEXT

Output Failure shows an appropriate error message.

set service-icmp

Description Service objects

Syntax set service-icmp <name> [ name <name> ] [ icmp-code <icmp-code> ] [


icmp-type <icmp-type> ] [ comments <comments> ]

Parameters

Parameter Description
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
ICMP code
icmp-code
Type: A number with no fractional part (integer)
ICMP message type
icmp-type
Type: A number with no fractional part (integer)
Service name
name
Type: String

Example set service-icmp TEXT name TEXT icmp-code -1000000 icmp-type -1000000
comments This is a comment.

Output Failure shows an appropriate error message.

set service-protocol

Description Service objects

Syntax set service-protocol <name> [ name <name> ] [ ip-protocol <ip-protocol> ] [


comments <comments> ] [ session-timeout <session-timeout> ] [ accept-replies
<accept-replies> ] [ sync-connections-on-cluster <sync-connections-on-cluster>
] [ match <match> ] [ aggressive-aging-enable <aggressive-aging-enable> ] [
aggressive-aging-timeout <aggressive-aging-timeout> ]

Parameters

Parameter Description
accept-replies Specifies if service replies are to be accepted

Command Line Interface Reference Guide R77.20 Embedded | 150


Enable to manage the connections table capacity and memory consumption of
aggressive-aging-
the firewall to increase durability and stability
enable
aggressive-aging- Time (in seconds) before the aggressive aging times out
timeout
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
IP Protocol number
ip-protocol
Type: A number with no fractional part (integer)
INSPECT expression that searches for a pattern in a packet, only relevant for
match
services of type ’other’
Service name
name
Type: String
session-timeout Time (in seconds) before the session times out
Enables state-synchronized High Availability or Load Sharing on a ClusterXL
or OPSEC-certified cluster. Of the services allowed by the rule base, only
sync-connections-on-
those with synchronize connections on cluster will be synchronized as they pass
cluster
through the cluster

Example set service-protocol TEXT name TEXT ip-protocol -1000000 comments


This is a comment. session-timeout -1000000 accept-replies true
sync-connections-on-cluster true match TEXT aggressive-aging-enable true
aggressive-aging-timeout -1000000

Output Failure shows an appropriate error message.

set service-tcp

Description Service objects

Syntax set service-tcp <name> [ name <name> ] [ port <port> ] [


comments <comments> ] [ session-timeout <session-timeout> ] [
sync-connections-on-cluster <sync-connections-on-cluster> ] [
sync-delay-enable <sync-delay-enable> ] [ delay-sync-interval
<delay-sync-interval> ] [ aggressive-aging-enable <aggressive-aging-enable>
] [ aggressive-aging-timeout <aggressive-aging-timeout> ] [ use-source-port {
false | true source-port <source-port> } ]

Parameters

Parameter Description
Enable to manage the connections table capacity and memory consumption of
aggressive-aging-
the firewall to increase durability and stability
enable
aggressive-aging- Time (in seconds) before the aggressive aging times out
timeout
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
delay-sync-interval Time (in seconds) after connection initiation to start synchronizing connections
Service name
name
Type: String
Destination ports (a comma separated list of ports/ranges)
port
Type: Port range
session-timeout Time (in seconds) before the session times out

Command Line Interface Reference Guide R77.20 Embedded | 151


source-port Source port
Enables state-synchronized High Availability or Load Sharing on a ClusterXL
or OPSEC-certified cluster. Of the services allowed by the rule base, only
sync-connections-on-
those with synchronize connections on cluster will be synchronized as they pass
cluster
through the cluster
sync-delay-enable True to delay connections synchronization
use-source-port Use source port

Example set service-tcp TEXT name TEXT port 8080-8090 comments This is a
comment. session-timeout -1000000 sync-connections-on-cluster true
sync-delay-enable true delay-sync-interval -1000000 aggressive-aging-enable
true aggressive-aging-timeout -1000000 use-source-port false source-port 8080

Output Failure shows an appropriate error message.

set service-udp

Description Service objects

Syntax set service-udp <name> [ name <name> ] [ port <port> ] [ comments <comments>
] [ session-timeout <session-timeout> ] [ accept-replies <accept-replies>
] [ sync-connections-on-cluster <sync-connections-on-cluster> ] [
aggressive-aging-enable <aggressive-aging-enable> ] [ aggressive-aging-timeout
<aggressive-aging-timeout> ]

Parameters

Parameter Description
accept-replies Specifies if service replies are to be accepted
Enable to manage the connections table capacity and memory consumption of
aggressive-aging-
the firewall to increase durability and stability
enable
aggressive-aging- Time (in seconds) before the aggressive aging times out
timeout
Comments and explanation about the service
comments Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
Service name
name
Type: String
Destination ports (a comma separated list of ports/ranges)
port
Type: Port range
session-timeout Time (in seconds) before the session times out
Enables state-synchronized High Availability or Load Sharing on a ClusterXL
or OPSEC-certified cluster. Of the services allowed by the rule base, only
sync-connections-on-
those with synchronize connections on cluster will be synchronized as they pass
cluster
through the cluster

Example set service-udp TEXT name TEXT port 8080-8090 comments This is a comment.
session-timeout -1000000 accept-replies true sync-connections-on-cluster true
aggressive-aging-enable true aggressive-aging-timeout -1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 152


set snmp

SNMP version3 user configuration options for: security level, authentication settings and passwords

set snmp
Description SNMP version3 user configuration options for: security level, authentication settings and passwords

Syntax set snmp user <user> security-level { true [ auth-pass-type


<auth-pass-type> ] [ auth-pass-phrase <auth-pass-phrase> ] [ privacy-pass-type
<privacy-pass-type> ] [ privacy-pass-phrase <privacy-pass-phrase> ] | false [
auth-pass-type <auth-pass-type> ] [ auth-pass-phrase <auth-pass-phrase> ] }

Parameters

Parameter Description
Authentication password for the SNMP version3 user
auth-pass-phrase
Type: A string that contains alphanumeric and special characters
Authentication protocol type for the version3 user, options are: MD5 or SHA1
auth-pass-type
Options: MD5, SHA1
Privacy password chosen by the version3 user in case privacy is set
privacy-pass-phrase
Type: A string that contains alphanumeric and special characters
Privacy protocol type for the version3 user, options are: AES or DES
privacy-pass-type
Options: AES, DES
Does Privacy protocol for this version3 user was set in the security level
security-level
Type: Boolean (true/false)
version3 user name
user
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Example set snmp user admin security-level true auth-pass-type MD5 auth-pass-phrase
a(ˆ
&7Ba privacy-pass-type AES privacy-pass-phrase a(ˆ
&7Ba

Output Failure shows an appropriate error message.

set snmp
Description SNMP general configuration options

Syntax set snmp [ agent <agent> ] [ agent-version <agent-version> ] [ community


<community> ] [ contact <contact> ] [ location <location> ]

Parameters

Parameter Description
Is SNMP option enabled or disabled, disabled is the default
agent
Type: Boolean (true/false)
Is the defined SNMP version is version3 only
agent-version
Type: Boolean (true/false)
Community name of the SNMP, public is the default
community
Type: A string of alphanumeric characters without space between them
System contact name, maximum length is 128
contact Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
System location name
location Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Command Line Interface Reference Guide R77.20 Embedded | 153


Example set snmp agent true agent-version true community word contact This is a
comment. location This is a comment.
Output Failure shows an appropriate error message.

set snmp traps

Configure, enable or disable traps from the list, the enabled traps are sent to the trap receivers

set snmp traps


Description Configure, enable or disable traps from the list, the enabled traps are sent to the trap receivers

Syntax set snmp traps { enable | disable }


Parameters

Parameter Description
snmpTrapsEnable
snmpTrapsEnable
Type: Boolean (true/false)

Example set snmp traps true

Output Failure shows an appropriate error message.

set snmp traps


Description Configure, enable or disable traps from the list, the enabled traps are sent to the trap receivers
Syntax set snmp traps trap-name <trap-name> [ enable <enable> ] [ severity
<severity> ] [ repetitions <repetitions> ] [ repetitions-delay
<repetitions-delay> ] [ threshold <threshold> ]

Parameters

Parameter Description
Enable or disable whether a trap is sent for the specific event
enable
Type: Boolean (true/false)
Repetitions on trap sending times between 0 - 10, optional field
repetitions
Type: A number with no fractional part (integer)
Wait time (in seconds) between sending each trap, optional field
repetitions-delay
Type: A number with no fractional part (integer)
Trap hazardous level, optional field, severity of the trap between 1 - 4
severity
Type: A number with no fractional part (integer)
The mathematical value associated with the thresholds
threshold
Type: A number with no fractional part (integer)
Trap event name
trap-name
Options: trap-name

Example set snmp traps trap-name interface-disconnected enable true severity


-1000000 repetitions -1000000 repetitions-delay -1000000 threshold -1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 154


set snmp traps
Description Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of
notifying the manager that something is wrong

Syntax set snmp traps receiver <receiver> version { v2 [ community <community> ] |


v3 [ user <user> ] }

Parameters

Parameter Description
Community name of the receivers trap, public is default for version2 users
community
Type: A string of alphanumeric characters without space between them
Receivers IP address that the trap associated with
receiver
Type: IP address
user SNMP version3 Defined users
SNMP Version number, options are: v2 or v3
version
Type: Press TAB to see available options

Example set snmp traps receiver 192.168.1.1 version v2 community word

Output Failure shows an appropriate error message.

set static-route

Description Static routes

Syntax set static-route <id> [ source <source> ] [ service <service> ] [


destination <destination> ] [ nexthop gateway { logical <logical> |
ipv4-address <ipv4-address> } ] [ metric <metric> ] [ disabled <disabled> ]

Parameters

Parameter Description
IP address and subnet length of the destination of the packet in the format
destination IP/subnet. e.g. 192.168.0.0/16
Type: An IP address with a mask length
Is rule disabled
disabled
Type: Boolean (true/false)
id
id
Type: A number with no fractional part (integer)
Metric
metric
Type: A number with no fractional part (integer)
Route service name
service
Type: String
IP address and subnet length of the source of the packet in the format IP/subnet.
source e.g. 192.168.1.0/24
Type: An IP address with a mask length

Example set static-route -1000000 source 172.15.47.0/24 service TEXT destination


172.15.47.0/24 nexthop gateway logical My_Network metric -1000000 disabled
true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 155


set streaming-engine-settings

Streaming engine settings

set streaming-engine-settings
Description Streaming engine settings

Syntax set streaming-engine-settings [ tcp-block-out-of-win-mon-only


<tcp-block-out-of-win-mon-only> ] [ tcp-block-out-of-win-track
<tcp-block-out-of-win-track> ] [ tcp-block-retrans-err-mon-only
<tcp-block-retrans-err-mon-only> ] [ tcp-block-retrans-err-track
<tcp-block-retrans-err-track> ] [ tcp-block-syn-retrans-mon-only
<tcp-block-syn-retrans-mon-only> ] [ tcp-block-syn-retrans-track
<tcp-block-syn-retrans-track> ] [ tcp-block-urg-bit-mon-only
<tcp-block-urg-bit-mon-only> ] [ tcp-block-urg-bit-track <tcp-block-urg-bit-track>
] [ tcp-hold-timeout-mon-only <tcp-hold-timeout-mon-only> ] [
tcp-hold-timeout-track <tcp-hold-timeout-track> ] [ tcp-invalid-checksum-mon-only
<tcp-invalid-checksum-mon-only> ] [ tcp-invalid-checksum-track
<tcp-invalid-checksum-track> ] [ tcp-segment-limit-mon-only
<tcp-segment-limit-mon-only> ] [ tcp-segment-limit-track <tcp-segment-limit-track>
]

Parameters

Parameter Description
TCP Out of Sequence activation mode
tcp-block-out-of-win-
Options: prevent, detect
mon-only
TCP Out of Sequence tracking
tcp-block-out-of-win-
Options: none, log, alert
track
TCP Invalid Retransmission activation mode
tcp-block-retrans-err-
Options: prevent, detect
mon-only
TCP Invalid Retransmission tracking
tcp-block-retrans-err-
Options: none, log, alert
track
TCP SYN Modified Retransmission activation mode
tcp-block-syn-retrans-
Options: prevent, detect
mon-only
TCP SYN Modified Retransmission tracking
tcp-block-syn-retrans-
Options: none, log, alert
track
TCP Urgent Data Enforcement activation mode
tcp-block-urg-bit-mon-
Options: prevent, detect
only
TCP Urgent Data Enforcement tracking
tcp-block-urg-bit-track
Options: none, log, alert
Stream Inspection Timeout activation mode
tcp-hold-timeout-mon-
Options: prevent, detect
only
Stream Inspection Timeout tracking
tcp-hold-timeout-track
Options: none, log, alert
TCP Invalid Checksum activation mode
tcp-invalid-checksum-
Options: prevent, detect
mon-only
TCP Invalid Checksum tracking
tcp-invalid-checksum-
Options: none, log, alert
track

Command Line Interface Reference Guide R77.20 Embedded | 156


TCP Segment Limit Enforcement activation mode
tcp-segment-limit-
Options: prevent, detect
mon-only
TCP Segment Limit Enforcement tracking
tcp-segment-limit-
Options: none, log, alert
track

Example set streaming-engine-settings tcp-block-out-of-win-mon-only prevent


tcp-block-out-of-win-track none tcp-block-retrans-err-mon-only prevent
tcp-block-retrans-err-track none tcp-block-syn-retrans-mon-only
prevent tcp-block-syn-retrans-track none tcp-block-urg-bit-mon-only
prevent tcp-block-urg-bit-track none tcp-hold-timeout-mon-only prevent
tcp-hold-timeout-track none tcp-invalid-checksum-mon-only prevent
tcp-invalid-checksum-track none tcp-segment-limit-mon-only prevent
tcp-segment-limit-track none
Output Failure shows an appropriate error message.

set streaming-engine-settings
Description Streaming engine settings

Syntax set streaming-engine-settings advanced-settings tcp-streaming-engine-setting-form


[ tcp-block-urg-bit-track <tcp-block-urg-bit-track> ] [ tcp-block-retrans-err-track
<tcp-block-retrans-err-track> ] [ tcp-block-syn-retrans-track
<tcp-block-syn-retrans-track> ] [ tcp-invalid-checksum-track
<tcp-invalid-checksum-track> ] [ tcp-block-out-of-win-mon-only
<tcp-block-out-of-win-mon-only> ] [ tcp-block-out-of-win-track
<tcp-block-out-of-win-track> ] [ tcp-block-retrans-err-mon-only
<tcp-block-retrans-err-mon-only> ] [ tcp-block-syn-retrans-mon-only
<tcp-block-syn-retrans-mon-only> ] [ tcp-invalid-checksum-mon-only
<tcp-invalid-checksum-mon-only> ] [ tcp-segment-limit-track
<tcp-segment-limit-track> ] [ tcp-block-urg-bit-mon-only <tcp-block-urg-bit-mon-only>
] [ tcp-segment-limit-mon-only <tcp-segment-limit-mon-only> ]
[ tcp-hold-timeout-mon-only <tcp-hold-timeout-mon-only> ] [
tcp-hold-timeout-track <tcp-hold-timeout-track> ]

Parameters There are no parameters

Example set streaming-engine-settings advanced-settings tcp-streaming-engine-setting-form


tcp-block-urg-bit-track none tcp-block-retrans-err-track none
tcp-block-syn-retrans-track none tcp-invalid-checksum-track none
tcp-block-out-of-win-mon-only prevent tcp-block-out-of-win-track none
tcp-block-retrans-err-mon-only prevent tcp-block-syn-retrans-mon-only
prevent tcp-invalid-checksum-mon-only prevent tcp-segment-limit-track
none tcp-block-urg-bit-mon-only prevent tcp-segment-limit-mon-only prevent
tcp-hold-timeout-mon-only prevent tcp-hold-timeout-track none

Output Failure shows an appropriate error message.

set switch

Switch

Command Line Interface Reference Guide R77.20 Embedded | 157


set switch
Description Switch

Syntax set switch <name> add port <port>

Parameters

Parameter Description
Name
name
Type: A switch name can be LAN[1-8]_Switch
port Name

Example set switch LAN2_Switch add port My_Network

Output Failure shows an appropriate error message.

set switch
Description Switch

Syntax set switch <name> remove port <port>

Parameters

Parameter Description
Name
name
Type: A switch name can be LAN[1-8]_Switch
port Name

Example set switch LAN2_Switch remove port My_Network

Output Failure shows an appropriate error message.

set threat-prevention anti-bot engine

Description Anti-Bot engine

Syntax set threat-prevention anti-bot engine [ malicious-activity


<malicious-activity> ] [ reputation-domains <reputation-domains> ] [
reputation-ips <reputation-ips> ] [ reputation-urls <reputation-urls> ] [
unusual-activity <unusual-activity> ]

Parameters

Parameter Description
Indicates if the action upon detecting malicious activity will be according to the
malicious-activity policy settings or a manually configured specific action
Options: ask, prevent, detect, inactive, policy-action
Indicates if the action upon detecting attempted access to domains with a bad
reputation-domains reputation will be according to the policy or a manually configured specific action
Options: ask, prevent, detect, inactive, policy-action
Indicates if the action upon detecting attempted access to IP addresses with a
bad reputation will be according to the policy or a manually configured specific
reputation-ips
action
Options: ask, prevent, detect, inactive, policy-action

Command Line Interface Reference Guide R77.20 Embedded | 158


Indicates if the action upon detecting attempted access to URLs with a bad
reputation-urls reputation will be according to the policy or a manually configured specific action
Options: ask, prevent, detect, inactive, policy-action
Indicates if the action upon detecting unusual activity will be according to the
unusual-activity policy or a manually configured specific action
Options: ask, prevent, detect, inactive, policy-action

Example set threat-prevention anti-bot engine malicious-activity ask


reputation-domains ask reputation-ips ask reputation-urls ask unusual-activity
ask

Output Failure shows an appropriate error message.

set threat-prevention anti-bot policy

Threat Prevention Anti-Bot policy

set threat-prevention anti-bot policy


Description Threat Prevention Anti-Bot policy

Syntax set threat-prevention anti-bot policy [ mode <mode> ] [ detect-mode


<detect-mode> ]

Parameters

Parameter Description
Indicates if the Anti-Bot blade is set to ’Detect Only’ mode
detect-mode
Type: Boolean (true/false)
Indicates if the Anti-Bot blade is active
mode
Type: Boolean (true/false)

Example set threat-prevention anti-bot policy mode true detect-mode true

Output Failure shows an appropriate error message.

set threat-prevention anti-bot policy


Description Threat Prevention Anti-Bot policy

Syntax set threat-prevention anti-bot policy advanced-settings res-class-mode


<res-class-mode>

Parameters There are no parameters

Example set threat-prevention anti-bot policy advanced-settings res-class-mode


rs-hold

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 159


set threat-prevention anti-bot user-check ask

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax set threat-prevention anti-bot user-check ask [ body <body> ] [


activity-text <activity-text> ] [ fallback-action <fallback-action> ]
[ frequency <frequency> ] [ subject <subject> ] [ title <title> ] [
reason-displayed <reason-displayed> ]

Parameters

Parameter Description
This text appears next to the ’ignore warning’ checkbox of an Anti-Bot ’Ask’ user
activity-text message
Type: A string that contains only printable characters
The informative text that appears in the Anti-Bot ’Ask’ user message
body
Type: A string that contains only printable characters
Indicates the action to take when an ’Ask’ user message cannot be displayed
fallback-action
Options: block, accept
Indicates how often is the Anti-Bot ’Ask’ user message is being presented to the
frequency same user
Options: day, week, month
Indicates if the user must enter a reason for ignoring this message in a desig-
reason-displayed nated text dialog
Type: Boolean (true/false)
The subject of an Anti-Bot ’Ask’ user message
subject
Type: A string that contains only printable characters
The title of an Anti-Bot ’Ask’ user message
title
Type: A string that contains only printable characters

Example set threat-prevention anti-bot user-check ask body My Network activity-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 threat-prevention anti-bot user-check block

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax set threat-prevention anti-bot user-check block [ body <body> ] [


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

Parameters

Parameter Description
The informative text that appears in the Anti-Bot ’Block’ user message
body
Type: A string that contains only printable characters
Indicates if the user will be redirected to a custom URL in case of a ’Block’ action
redirect-to-url
Type: Boolean (true/false)
Indicates the URL to redirect the user in case of a ’Block’ action if configured
to do so. The URL to redirect the user in case of a ’Block’ action. Redirection
redirect-url
happens only if this functionality is turned on
Type: urlWithHttp

Command Line Interface Reference Guide R77.20 Embedded | 160


The subject of an Anti-Bot ’Block’ user message
subject
Type: A string that contains only printable characters
The title of an Anti-Bot ’Block’ user message
title
Type: A string that contains only printable characters

Example set threat-prevention anti-bot 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.

set threat-prevention anti-virus engine

Description Anti-Virus engine

Syntax set threat-prevention anti-virus engine [ urls-with-malware


<urls-with-malware> ] [ viruses <viruses> ]

Parameters

Parameter Description
Indicates if the action upon detecting access to and from URLs with a bad rep-
urls-with-malware utation will be according to the policy or a manually configured specific action
Options: ask, prevent, detect, inactive, policy-action
Indicates if the action upon detecting viruses will be according to the policy or a
viruses manually configured specific action
Options: ask, prevent, detect, inactive, policy-action

Example set threat-prevention anti-virus engine urls-with-malware ask viruses ask

Output Failure shows an appropriate error message.

set threat-prevention anti-virus file-type

Description Manage Anti-Virus policy per file type

Syntax set threat-prevention anti-virus file-type extension <extension> [ action


<action> ] [ description <description> ]

Parameters

Parameter Description
Indicates the action when the file type is detected
action
Options: block, pass, scan
The file description
description Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
File extension that represents this file type
extension Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Example set threat-prevention anti-virus file-type extension This is a comment.


action block description This is a comment.

Command Line Interface Reference Guide R77.20 Embedded | 161


Output Failure shows an appropriate error message.

set threat-prevention anti-virus policy

Threat Prevention Anti-Virus policy

set threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy

Syntax set threat-prevention anti-virus policy [ mode <mode> ] [ detect-mode


<detect-mode> ] [ scope <scope> [ interfaces <interfaces> ] ] [ protocol-http
<protocol-http> ] [ protocol-mail <protocol-mail> ] [ protocol-ftp
<protocol-ftp> ] [ file-types-policy <file-types-policy> ]

Parameters

Parameter Description
Indicates if the Anti-Virus blade is set to ’Detect Only’ mode
detect-mode
Type: Boolean (true/false)
Indicates the file types that are inspected by the Anti-Virus blade: malware
file-types-policy (known to contain malware), all (all file types), specific (configured file families)
Options: malware, all-types, specific-families
Indicates the source zones for inspected incoming files: External, External and
interfaces DMZ or all interfaces
Options: all, external, external-dmz
Indicates if the Anti-Virus blade is active
mode
Type: Boolean (true/false)
Indicates if Anti-Virus inspection will be performed on FTP traffic
protocol-ftp
Type: Boolean (true/false)
Indicates if Anti-Virus inspection will be performed on all configured ports of
protocol-http HTTP traffic
Type: Boolean (true/false)
Indicates if Anti-Virus inspection will be performed on mail traffic (SMTP and
protocol-mail POP3)
Type: Boolean (true/false)
Indicates the source of scanned filed: Scan incoming files, or scan both incom-
scope ing and outgoing files
Options: incoming, incoming-and-outgoing

Example set threat-prevention anti-virus policy mode true detect-mode true scope
incoming interfaces all protocol-http true protocol-mail true protocol-ftp
true file-types-policy malware

Output Failure shows an appropriate error message.

set threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy

Syntax set threat-prevention anti-virus policy advanced-settings priority-scanning


<priority-scanning>

Parameters There are no parameters

Command Line Interface Reference Guide R77.20 Embedded | 162


Example set threat-prevention anti-virus policy advanced-settings priority-scanning
true
Output Failure shows an appropriate error message.

set threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy
Syntax set threat-prevention anti-virus policy advanced-settings file-scan-size-kb
<file-scan-size-kb>
Parameters There are no parameters
Example set threat-prevention anti-virus policy advanced-settings file-scan-size-kb
-1000000
Output Failure shows an appropriate error message.

set threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy
Syntax set threat-prevention anti-virus policy advanced-settings max-nesting-level
<max-nesting-level>
Parameters There are no parameters
Example set threat-prevention anti-virus policy advanced-settings max-nesting-level
-1000000
Output Failure shows an appropriate error message.

set threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy
Syntax set threat-prevention anti-virus policy advanced-settings
action-when-nesting-level-exceeded <action-when-nesting-level-exceeded>
Parameters There are no parameters
Example set threat-prevention anti-virus policy advanced-settings
action-when-nesting-level-exceeded allow
Output Failure shows an appropriate error message.

set threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy
Syntax set threat-prevention anti-virus policy advanced-settings res-class-mode
<res-class-mode>
Parameters There are no parameters
Example set threat-prevention anti-virus policy advanced-settings res-class-mode
rs-hold
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 163


set threat-prevention anti-virus user-check ask

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax set threat-prevention anti-virus user-check ask [ body <body> ] [


activity-text <activity-text> ] [ fallback-action <fallback-action> ]
[ frequency <frequency> ] [ subject <subject> ] [ title <title> ] [
reason-displayed <reason-displayed> ]

Parameters

Parameter Description
This text appears next to the ’ignore warning’ checkbox of an Anti-Virus ’Ask’
activity-text user message
Type: A string that contains only printable characters
The informative text that appears in the Anti-Virus ’Ask’ user message
body
Type: A string that contains only printable characters
Indicates the action to take when an ’Ask’ user message cannot be displayed
fallback-action
Options: block, accept
Indicates how often is the Anti-Virus ’Ask’ user message is being presented to
frequency the same user
Options: day, week, month
Indicates if the user must enter a reason for ignoring this message in a desig-
reason-displayed nated text dialog
Type: Boolean (true/false)
The subject of an Anti-Virus ’Ask’ user message
subject
Type: A string that contains only printable characters
The title of an Anti-Virus ’Ask’ user message
title
Type: A string that contains only printable characters

Example set threat-prevention anti-virus user-check ask body My Network


activity-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 threat-prevention anti-virus user-check block

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax set threat-prevention anti-virus user-check block [ body <body> ] [


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

Parameters

Parameter Description
The informative text that appears in the Anti-Virus ’Block’ user message
body
Type: A string that contains only printable characters
Indicates if the user will be redirected to a custom URL in case of a ’Block’ action
redirect-to-url
Type: Boolean (true/false)
Indicates the URL to redirect the user in case of a ’Block’ action if configured
to do so. The URL to redirect the user in case of a ’Block’ action. Redirection
redirect-url
happens only if this functionality is turned on
Type: urlWithHttp

Command Line Interface Reference Guide R77.20 Embedded | 164


The subject of an Anti-Virus ’Block’ user message
subject
Type: A string that contains only printable characters
The title of an Anti-Virus ’Block’ user message
title
Type: A string that contains only printable characters

Example set threat-prevention anti-virus 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.

set threat-prevention exception

Description Malware exceptions

Syntax set threat-prevention exception name <name> [ comment <comment> ] [ scope


<scope> ] [ protection <protection> ] [ action <action> ] [ log <log> ] [
new-name <new-name> ]

Parameters

Parameter Description
The action taken when there is a match on the rule
action
Options: ask, prevent, detect, inactive
Additional description for the exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
The logging method used when there is a match on the rule: None - do not log,
log Log - Create log, Alert - log with alert
Options: none, log, alert
The name of the exception
name
Type: A string of alphanumeric characters without space between them
The name of the exception
new-name
Type: A string of alphanumeric characters without space between them
The blade to which the exception applies: Anti-Virus and Anti-Bot (malware),
protection Anti-Virus (antivirus) or Anti-Bot (antibot)
Options: any, any-ab, any-av
scope IP address, network object or user group that the exception applies to

Example set threat-prevention exception name word comment This is a comment. scope
TEXT protection any action ask log none new-name word
Output Failure shows an appropriate error message.

set threat-prevention exception position

Description Malware exceptions


Syntax set threat-prevention exception position <position> [ comment <comment> ] [
scope <scope> ] [ protection <protection> ] [ action <action> ] [ log <log> ]
[ new-name <new-name> ]
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 165


Parameter Description
The action taken when there is a match on the rule
action
Options: ask, prevent, detect, inactive
Additional description for the exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
The logging method used when there is a match on the rule: None - do not log,
log Log - Create log, Alert - log with alert
Options: none, log, alert
The name of the exception
new-name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other rules
position
Type: Decimal number
The blade to which the exception applies: Anti-Virus and Anti-Bot (malware),
protection Anti-Virus (antivirus) or Anti-Bot (antibot)
Options: any, any-ab, any-av
scope IP address, network object or user group that the exception applies to

Example set threat-prevention exception position 2 comment This is a comment.


scope TEXT protection any action ask log none new-name word

Output Failure shows an appropriate error message.

set threat-prevention ips custom-default-policy

Description Configure the custom default policy if chosen as custom

Syntax set threat-prevention ips custom-default-policy [ server-protections


<server-protections> ] [ client-protections <client-protections> ]
[ disable-by-confidence-level <disable-by-confidence-level > ] [
disable-confidence-level-below-or-equal <disable-confidence-level-below-or-equal>
] [ disable-by-severity <disable-by-severity> ] [ disable-severity-below-or-equal
<disable-severity-below-or-equal> ] [ disable-by-performance-impact
<disable-by-performance-impact> ] [ disable-performance-impact-above-or-equal
<disable-performance-impact-above-or-equal> ] [ disable-protocol-anomalies
<disable-protocol-anomalies> ]

Parameters

Parameter Description
Indicates if Client protections are active by default
client-protections
Type: Boolean (true/false)
Indicates if protections will be deactivated if their confidence level is below or
disable-by- equal configured level
confidence-level Type: Boolean (true/false)
Indicates if protections will be deactivated if their performance impact is above
disable-by- or equal configured level
performance-impact Type: Boolean (true/false)
Indicates if protections will be deactivated if their severity is below or equal con-
disable-by-severity figured level
Type: Boolean (true/false)
If configured, protections will be deactivated according to this confidence level
disable-confidence-
Options: Low, Medium-low, Medium, Medium-high, High
level-below-or-equal

Command Line Interface Reference Guide R77.20 Embedded | 166


If configured, protections will be deactivated according to this performance im-
disable-performance- pact level
impact-above-or-equal Options: Very-low, Low, Medium, High
Do not activate protocol anomaly detection signatures
disable-protocol-
Type: Boolean (true/false)
anomalies
If configured, protections will be deactivated according to this severity level
disable-severity-
Options: Low, Medium, High, Critical
below-or-equal
Indicates if Server protections are active by default
server-protections
Type: Boolean (true/false)

Example set threat-prevention ips custom-default-policy server-protections


true client-protections true disable-by-confidence-level true
disable-confidence-level-below-or-equal Low disable-by-severity true
disable-severity-below-or-equal Low disable-by-performance-impact true
disable-performance-impact-above-or-equal Very-low disable-protocol-anomalies
true
Output Failure shows an appropriate error message.

set threat-prevention ips network-exception

Configure exception rules to bypass IPS protections for specific traffic

set threat-prevention ips network-exception


Description Configure exception rules to bypass IPS protections for specific traffic

Syntax set threat-prevention ips network-exception position <position>


[ protection-code <protection-code> ] [ destination <destination> ]
[ destination-negate <destination-negate> ] [ service <service> ] [
service-negate <service-negate> ] [ source <source> ] [ source-negate
<source-negate> ] [ comment <comment> ]

Parameters

Parameter Description
Comment on the IPS Network exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
The order of the rule in the rule base
position
Type: Decimal number
protection-code Indicates if the exception rule will be matched on all IPS protections or a specific
one
service Type of network service that is under exception
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the service is everything except what is defined in the service field
source-negate
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 167


Example set threat-prevention ips network-exception position 2 protection-code
-1000000 destination TEXT destination-negate true service TEXT service-negate
true source TEXT source-negate true comment This is a comment.

Output Failure shows an appropriate error message.

set threat-prevention ips network-exception


Description Configure exception rules to bypass IPS protections for specific traffic

Syntax set threat-prevention ips network-exception position <position>


protection-name <protection-name> [ destination <destination> ] [
destination-negate <destination-negate> ] [ service <service> ] [
service-negate <service-negate> ] [ source <source> ] [ source-negate
<source-negate> ] [ comment <comment> ]

Parameters

Parameter Description
Comment on the IPS Network exception
comment Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @
destination Network object that is the target of the connection
If true, the destination is all traffic except what is defined in the destination field
destination-negate
Type: Boolean (true/false)
The order of the rule in the rule base
position
Type: Decimal number
protection-name Indicates if the exception rule will be matched on all IPS protections or a specific
one
service Type of network service that is under exception
If true, the service is everything except what is defined in the service field
service-negate
Type: Boolean (true/false)
source Network object or user group that initiates the connection
If true, the service is everything except what is defined in the service field
source-negate
Type: Boolean (true/false)

Example set threat-prevention ips network-exception position 2 protection-name


word destination TEXT destination-negate true service TEXT service-negate true
source TEXT source-negate true comment This is a comment.

Output Failure shows an appropriate error message.

set threat-prevention ips policy

Description Threat Prevention IPS global policy

Syntax set threat-prevention ips policy [ mode <mode> ] [ log <log> ] [


default-policy <default-policy> ] [ detect-mode <detect-mode> ]

Parameters

Parameter Description
default-policy The type of policy used for IPS - strict, typical or custom
Indicates if the default policy of IPS is to only logs events and not block them
detect-mode
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 168


Indicates the tracking level for IPS - none, block or alert
log
Options: none, log, alert
Indicates if IPS blade is active
mode
Type: Boolean (true/false)

Example set threat-prevention ips policy mode true log none default-policy word
detect-mode true

Output Failure shows an appropriate error message.

set threat-prevention ips protection-action-override

IPS topic view

set threat-prevention ips protection-action-override


Description IPS topic view

Syntax set threat-prevention ips protection-action-override protection-code


<protection-code> [ action <action> ] [ track <track> ]

Parameters

Parameter Description
action Indicates the manually configured action for this protection
The IPS topic the override belongs to. Every override belongs to a single topic
protection-code Type: A number with no fractional part. Values are between -
4,503,599,627,370,495 to 4,503,599,627,370,495
track Indicates the manually configured tracking option for this protection

Example set threat-prevention ips protection-action-override protection-code


-1000000 action prevent track none

Output Failure shows an appropriate error message.

set threat-prevention ips protection-action-override


Description IPS topic view

Syntax set threat-prevention ips protection-action-override protection-name


<protection-name> [ action <action> ] [ track <track> ]

Parameters

Parameter Description
action Indicates the manually configured action for this protection
The name of the IPS topic
protection-name
Type: A string of alphanumeric characters without space between them
track Indicates the manually configured tracking option for this protection

Example set threat-prevention ips protection-action-override protection-name word


action prevent track none

Command Line Interface Reference Guide R77.20 Embedded | 169


Output Failure shows an appropriate error message.

set threat-prevention ips protection-action-override


Description IPS topic view

Syntax set threat-prevention ips protection-action-override protection-code


<protection-code> override-policy-action <override-policy-action>

Parameters

Parameter Description
Indicates if the action upon detection will be according to the general IPS policy
override-policy-action or manually configured for this protection
Type: Boolean (true/false)
The IPS topic the override belongs to. Every override belongs to a single topic
protection-code Type: A number with no fractional part. Values are between -
4,503,599,627,370,495 to 4,503,599,627,370,495

Example set threat-prevention ips protection-action-override protection-code


-1000000 override-policy-action true
Output Failure shows an appropriate error message.

set threat-prevention ips protection-action-override


Description IPS topic view

Syntax set threat-prevention ips protection-action-override protection-name


<protection-name> override-policy-action <override-policy-action>
Parameters

Parameter Description
Indicates if the action upon detection will be according to the general IPS policy
override-policy-action or manually configured for this protection
Type: Boolean (true/false)
The name of the IPS topic
protection-name
Type: A string of alphanumeric characters without space between them

Example set threat-prevention ips protection-action-override protection-name word


override-policy-action true
Output Failure shows an appropriate error message.

set threat-prevention policy

Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot

set threat-prevention policy


Description Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot

Command Line Interface Reference Guide R77.20 Embedded | 170


Syntax set threat-prevention policy [ high-confidence <high-confidence> ] [
medium-confidence <medium-confidence> ] [ low-confidence <low-confidence> ]
[ performance-impact <performance-impact> ] [ track <track> ]

Parameters

Parameter Description
Indicates the default action for Threat Prevention protections with a high confi-
high-confidence dence level
Options: ask, prevent, detect, inactive
Indicates the default action for Threat Prevention protections with a low confi-
low-confidence dence level
Options: ask, prevent, detect, inactive
Indicates the default action for Threat Prevention protections with a medium
medium-confidence confidence level
Options: ask, prevent, detect, inactive
Indicates the allowed performance impact of active Threat Prevention protec-
performance-impact tions by default
Options: low, medium, high
Tracking options for Threat Prevention protections: None - do not log, Log -
track Create log, Alert - log with alert
Options: none, log, alert

Example set threat-prevention policy high-confidence ask medium-confidence ask


low-confidence ask performance-impact low track none

Output Failure shows an appropriate error message.

set threat-prevention policy


Description Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot

Syntax set threat-prevention policy advanced-settings fail-mode <fail-mode>

Parameters There are no parameters

Example set threat-prevention policy advanced-settings fail-mode allow-all-requests

Output Failure shows an appropriate error message.

set threat-prevention policy


Description Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot

Syntax set threat-prevention policy advanced-settings block-requests-when-the-web-service-is-u


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

Parameters There are no parameters

Example set threat-prevention policy advanced-settings block-requests-when-the-web-service-is-


true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 171


set threat-prevention-advanced

Description Advanced settings for Threat Prevention

Syntax set threat-prevention-advanced advanced-settings file-inspection-size-kb


<file-inspection-size-kb>

Parameters There are no parameters

Example set threat-prevention-advanced advanced-settings file-inspection-size-kb


-1000000

Output Failure shows an appropriate error message.

set ui-settings

Web Interface Settings and Customizations

set ui-settings
Description Web Interface Settings and Customizations

Syntax set ui-settings [ use-custom-webui-logo <use-custom-webui-logo> ] [


custom-webui-logo-url <custom-webui-logo-url> ]

Parameters

Parameter Description
Clicking the company logo in the web interface opens this URL
custom-webui-logo-url
Type: urlWithHttp
The company logo is displayed on the appliance’s web interface and on its log-
in page. The customized logo should follow the size restrictions in order to be
use-custom-webui-
displayed properly.
logo
Type: Boolean (true/false)

Example set ui-settings use-custom-webui-logo true custom-webui-logo-url


urlWithHttp

Output Failure shows an appropriate error message.

set ui-settings
Description Web Interface Settings and Customizations

Syntax set ui-settings advanced-settings AboutConfigCustomLogos [


custom-webui-logo-url <custom-webui-logo-url> ] [ use-custom-webui-logo
<use-custom-webui-logo> ]

Parameters There are no parameters

Example set ui-settings advanced-settings AboutConfigCustomLogos


custom-webui-logo-url urlWithHttp use-custom-webui-logo true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 172


set usb-modem-watchdog

Uses the internet probing (if probing is enabled) to automatically detect and fix 3G/4G internet connectivity prob-
lems

set usb-modem-watchdog
Description Uses the internet probing (if probing is enabled) to automatically detect and fix 3G/4G internet con-
nectivity problems

Syntax set usb-modem-watchdog advanced-settings interval <interval>

Parameters There are no parameters

Example set usb-modem-watchdog advanced-settings interval -1000000

Output Failure shows an appropriate error message.

set usb-modem-watchdog
Description Uses the internet probing (if probing is enabled) to automatically detect and fix 3G/4G internet con-
nectivity problems

Syntax set usb-modem-watchdog advanced-settings mode <mode>

Parameters There are no parameters

Example set usb-modem-watchdog advanced-settings mode off

Output Failure shows an appropriate error message.

set user-awareness

User awareness configuration table

set user-awareness
Description User awareness configuration table

Syntax set user-awareness [ mode <mode> ] [ ad-queries-mode <ad-queries-mode> ] [


browser-based-authentication-mode <browser-based-authentication-mode> ]

Parameters

Parameter Description
Indicates if user awareness seamlessly queries the AD (Active Directory)
ad-queries-mode servers to get user information
Type: Boolean (true/false)
Indicates if user awareness uses a portal to identify locally defined users or as
browser-based- a backup to other identification methods
authentication-mode Type: Boolean (true/false)
User awareness mode - true for on, false for off
mode
Type: Boolean (true/false)

Command Line Interface Reference Guide R77.20 Embedded | 173


Example set user-awareness mode true ad-queries-mode true browser-based-authentication-mode
true
Output Failure shows an appropriate error message.

set user-awareness
Description User awareness configuration table

Syntax set user-awareness advanced-settings association-timeout


<association-timeout>
Parameters There are no parameters

Example set user-awareness advanced-settings association-timeout -1000000

Output Failure shows an appropriate error message.

set user-awareness
Description User awareness configuration table
Syntax set user-awareness advanced-settings assume-single-user <assume-single-user>

Parameters There are no parameters

Example set user-awareness advanced-settings assume-single-user true

Output Failure shows an appropriate error message.

set user-awareness browser-based-authentication

User awareness configuration table

set user-awareness browser-based-authentication


Description User awareness configuration table

Syntax set user-awareness browser-based-authentication [ redirect-upon-destinations


{ manually-defined [ redirect-upon-destination-internet <redirect-upon-destination-intern
] [ redirect-upon-destinations-net-objs <redirect-upon-destinations-net-objs>
] | all } ] [ block-unauthenticated-non-web-traffic <block-unauthenticated-non-web-traffi
] [ require-user-agreement <require-user-agreement> ] [ agreement-text
<agreement-text> ] [ portal-address <portal-address> ] [ session-timeout
<session-timeout> ] [ log-out-on-portal-close <log-out-on-portal-close> ]

Parameters

Parameter Description
The conditions shown to the users to agree to
agreement-text
Type: A string that contains only printable characters
When true, users using non-HTTP traffic are forced to login first through
block- Browser-Based Authentication
unauthenticated- Type: Boolean (true/false)
non-web-traffic

Command Line Interface Reference Guide R77.20 Embedded | 174


When true, the user is forced to keep the portal window open to remain logged
log-out-on-portal- in
close Type: Boolean (true/false)
Use the auto option unless you want to redirect to a manually configured URL
portal-address Type: String
Enter "<auto>" for default
When choosing redirect to manually defined destinations - indicates if the desti-
redirect-upon- nations include the internet (external interfaces)
destination-internet Type: Boolean (true/false)
Browser based authentication will only be shown to unidentified users on traffic
redirect-upon- to these configured destinations
destinations Type: Press TAB to see available options
When choosing redirect to manually defined destinations - indicates if the desti-
redirect-upon- nations include a manual list of network objects
destinations-net-objs Type: Boolean (true/false)
Indicates if users must agree to the legal conditions
require-user-
Type: Boolean (true/false)
agreement
Session timeout duration, in minutes, for browser-based authentication
session-timeout Type: A number with no fractional part (integer)
Units should be entered in minutes

Example set user-awareness browser-based-authentication redirect-upon-destinations


manually-defined redirect-upon-destination-internet true redirect-upon-destinations-net-o
true block-unauthenticated-non-web-traffic true require-user-agreement
true agreement-text My Network portal-address TEXT session-timeout -1000000
log-out-on-portal-close true

Output Failure shows an appropriate error message.

set user-awareness browser-based-authentication


Description User awareness configuration table

Syntax set user-awareness browser-based-authentication add net-obj <net-obj>


Parameters

Parameter Description
net-obj Network object name

Example set user-awareness browser-based-authentication add net-obj TEXT

Output Failure shows an appropriate error message.

set user-awareness browser-based-authentication


Description User awareness configuration table

Syntax set user-awareness browser-based-authentication remove net-obj <net-obj>

Parameters

Parameter Description
net-obj Network object name

Command Line Interface Reference Guide R77.20 Embedded | 175


Example set user-awareness browser-based-authentication remove net-obj TEXT

Output Failure shows an appropriate error message.

set user-awareness browser-based-authentication


Description User awareness configuration table

Syntax set user-awareness browser-based-authentication remove-all net-objs

Parameters There are no parameters

Example set user-awareness browser-based-authentication remove-all net-objs

Output Failure shows an appropriate error message.

set vpn

Configure remote VPN sites

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> [ enabled <enabled> ] [ remote-site-enc-dom-type


<remote-site-enc-dom-type> ] [ enc-profile <enc-profile> ] [
phase1-reneg-interval <phase1-reneg-interval> ] [ phase2-reneg-interval
<phase2-reneg-interval> ] [ enable-perfect-forward-secrecy { true [
phase2-dh <phase2-dh> ] | false } ] [ is-check-point-site { true [
enable-permanent-vpn-tunnel <enable-permanent-vpn-tunnel> ] | false
} ] [ disable-nat <disable-nat> ] [ aggressive-mode-enabled { true
aggressive-mode-DH-group <aggressive-mode-DH-group> | false } ] [ {
aggressive-mode-enable-peer-id { true aggressive-mode-peer-id-type
<aggressive-mode-peer-id-type> aggressive-mode-peer-id <aggressive-mode-peer-id>
| false } | aggressive-mode-enable-gateway-id { true aggressive-mode-gateway-id-type
<aggressive-mode-gateway-id-type> aggressive-mode-gateway-id
<aggressive-mode-gateway-id> | false } } ] [ enc-method <enc-method> ]
[ use-trusted-ca <use-trusted-ca> ] [ match-cert-ip <match-cert-ip> ] [
match-cert-dn { true match-cert-dn-string <match-cert-dn-string> | false } ]
[ match-cert-e-mail { true match-cert-e-mail-string <match-cert-e-mail-string>
| false } ] [ link-selection-probing-method <link-selection-probing-method>
] [ name <name> ] [ remote-site-link-selection <remote-site-link-selection>
] [ remote-site-host-name <remote-site-host-name> ] [ remote-site-ip-address
<remote-site-ip-address> ] [ is-site-behind-static-nat <is-site-behind-static-nat>
] [ static-nat-ip <static-nat-ip> ] [ auth-method { preshared-secret
password <password> | certificate } ] [ link-selection-primary-addr
<link-selection-primary-addr> ]

Parameters

Parameter Description
aggressive-mode-DH- determine the strength of the key when aggressive mode is enabled
group

Command Line Interface Reference Guide R77.20 Embedded | 176


Indicates if gateway ID matching will be used. This adds a layer of security to
aggressive-mode- aggressive mode
enable-gateway-id Type: Boolean (true/false)
Indicates if peer ID matching will be used. This adds a layer of security to
aggressive-mode- aggressive mode
enable-peer-id Type: Boolean (true/false)
Indicates if Aggressive mode, a less secure negotiation protocol compared to
main mode, is used. It is less recommended if the remote site supports IPSec
aggressive-mode-
main mode
enabled
Type: Boolean (true/false)
The gateway ID that will be used for matching when configured to
aggressive-mode-
Type: vpnAggressiveModePeerId
gateway-id
Indicates the type of gateway ID that will be used for matching when configured
aggressive-mode-
Options: domain-name, user-name
gateway-id-type
The peer ID that will be used for matching when configured to
aggressive-mode-
Type: vpnAggressiveModePeerId
peer-id
Indicates the type of peer ID that will be used for matching when configured
aggressive-mode-
Options: domain-name, user-name
peer-id-type
Indicates the type of authentication used when connecting to the remote site
auth-method
Type: Press TAB to see available options
Disable NAT for traffic to/from the remote site. Useful when one of the internal
disable-nat networks contains a server
Type: Boolean (true/false)
Ensures that a session key will not be compromised if one of the (long-term)
enable-perfect- private keys is compromised in the future.
forward-secrecy Type: Boolean (true/false)
VPN Tunnels are constantly kept active and as a result, make it easier to recog-
enable-permanent- nize malfunctions and connectivity problems
vpn-tunnel Type: Boolean (true/false)
Indicates whether or not the remote site is enabled
enabled
Type: Boolean (true/false)
Indicates which encryption method is used
enc-method
Options: ike-v1, ike-v2, prefer-ike-v2
Encryption profile (one of predefined profiles or custom)
enc-profile
Type: virtual
Enable if the remote site is connected through a Check Point Security Gateway
is-check-point-site
Type: Boolean (true/false)
is-site-behind-static- When connection type is IP address, this indicates if it is behind static NAT
nat
Specifies The primary IP address for the link selection
link-selection-primary-
Type: A string of alphanumeric characters without space between them
addr
The type of probing used for link selection when multiple IP addresses are con-
link-selection-probing- figured for the remote site
method Options: ongoing, one-time
Indicates if certificate matching should match the DN string in the certificate to
match-cert-dn the configured DN string
Type: Boolean (true/false)
Indicates the configured DN string for certificate matching
match-cert-dn-string
Type: String
Indicates if certificate matching should match the E-mail string in the certificate
match-cert-e-mail to the configured E-mail string
Type: Boolean (true/false)
Indicates the configured E-mail string for certificate matching
match-cert-e-mail-
Type: Email address
string

Command Line Interface Reference Guide R77.20 Embedded | 177


Indicates if certificate matching should match IP address in the certificate to the
match-cert-ip site’s IP address
Type: Boolean (true/false)
Site name
name Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces
Preshared secret (minimum 6 characters) to be used when authentication
password method is configured as such
Type: vpnPassword
The period, in minutes, between each IKE SA renegotiation
phase1-reneg-interval
Type: A number with no fractional part (integer)
Determine the strength of the key used for the IPsec (Phase 2) key exchange
phase2-dh process. The higher the group number, the stronger and more secure the key
is.
The period, in seconds, between each IPSec SA renegotiation
phase2-reneg-interval
Type: A number with no fractional part (integer)
The method of defining the remote site’s encryption domain
remote-site-enc-dom- Options: manually-defined-enc-dom, route-all-traffic-to-site, route-based-vpn,
type enc-dom-hidden-behind-remote-site
remote-site-host- Indicates the remote site’s host name when the link selection method is config-
name ured as such
Indicates the remote site’s single IP address when the link selection method is
remote-site-ip-
configured as such
address
Indicates the method of determining the destination IP address/s of the remote
site
remote-site-link-
Options: ip-address, host-name, high-availability, load-sharing, connection-
selection
initiated-only-from-remote-site
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces
Indicates an external routable IP address via static NAT used by the remote site,
static-nat-ip
when configured as such
Indicates if a specific trusted CA is used for matching the remote site’s certificate
use-trusted-ca
or all configured trusted CAs

Example set vpn site site17 enabled true remote-site-enc-dom-type


manually-defined-enc-dom enc-profile virtual phase1-reneg-interval
-1000000 phase2-reneg-interval -1000000 enable-perfect-forward-secrecy
true phase2-dh word is-check-point-site true enable-permanent-vpn-tunnel
true disable-nat true aggressive-mode-enabled true aggressive-mode-DH-group
word aggressive-mode-enable-peer-id true aggressive-mode-peer-id-type
domain-name aggressive-mode-peer-id vpnAggressiveModePeerId enc-method ike-v1
use-trusted-ca TEXT match-cert-ip true match-cert-dn true match-cert-dn-string
TEXT match-cert-e-mail true match-cert-e-mail-string MyEmail@mail.com
link-selection-probing-method ongoing name site17 remote-site-link-selection
ip-address remote-site-host-name myHost.com remote-site-ip-address 192.168.1.1
is-site-behind-static-nat true static-nat-ip 192.168.1.1 auth-method
preshared-secret password vpnPassword link-selection-primary-addr word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites
Syntax set vpn site <site> add remote-site-enc-dom-network-obj <remote-site-enc-dom-network-ob

Command Line Interface Reference Guide R77.20 Embedded | 178


Parameters

Parameter Description
remote-site-enc-dom- Network Object name
network-obj
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add remote-site-enc-dom-network-obj TEXT

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove-all remote-site-enc-dom-network-obj


<remote-site-enc-dom-network-obj>

Parameters

Parameter Description
remote-site-enc-dom- Network Object name
network-obj
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all remote-site-enc-dom-network-obj TEXT

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove remote-site-enc-dom-network-obj


<remote-site-enc-dom-network-obj>

Parameters

Parameter Description
remote-site-enc-dom- Network Object name
network-obj
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove remote-site-enc-dom-network-obj TEXT

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 179


set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> add link-selection-multiple-addrs addr


<link-selection-multiple-addrs addr>

Parameters

Parameter Description
link-selection-multiple- IP address
addrs addr
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add link-selection-multiple-addrs addr 192.168.1.1

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites
Syntax set vpn site <site> remove-all link-selection-multiple-addrs addr
<link-selection-multiple-addrs addr>

Parameters

Parameter Description
link-selection-multiple- IP address
addrs addr
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all link-selection-multiple-addrs addr


192.168.1.1

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove link-selection-multiple-addrs addr


<link-selection-multiple-addrs addr>

Parameters

Parameter Description
link-selection-multiple- IP address
addrs addr
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Command Line Interface Reference Guide R77.20 Embedded | 180


Example set vpn site site17 remove link-selection-multiple-addrs addr 192.168.1.1

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> add custom-enc-phase1-enc <custom-enc-phase1-enc>

Parameters

Parameter Description
Encryption algorithm preferences for phase1 in the VPN encryption algorithm,
custom-enc-phase1-
which sets the base for phase2
enc
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add custom-enc-phase1-enc word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove-all custom-enc-phase1-enc <custom-enc-phase1-enc>

Parameters

Parameter Description
Encryption algorithm preferences for phase1 in the VPN encryption algorithm,
custom-enc-phase1-
which sets the base for phase2
enc
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all custom-enc-phase1-enc word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove custom-enc-phase1-enc <custom-enc-phase1-enc>

Parameters

Parameter Description
Encryption algorithm preferences for phase1 in the VPN encryption algorithm,
custom-enc-phase1-
which sets the base for phase2
enc

Command Line Interface Reference Guide R77.20 Embedded | 181


Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove custom-enc-phase1-enc word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> add custom-enc-phase1-auth <custom-enc-phase1-auth>

Parameters

Parameter Description
custom-enc-phase1- Authentication algorithm used for encryption validation
auth
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add custom-enc-phase1-auth word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove-all custom-enc-phase1-auth <custom-enc-phase1-auth>

Parameters

Parameter Description
custom-enc-phase1- Authentication algorithm used for encryption validation
auth
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all custom-enc-phase1-auth word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove custom-enc-phase1-auth <custom-enc-phase1-auth>

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 182


Parameter Description
custom-enc-phase1- Authentication algorithm used for encryption validation
auth
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove custom-enc-phase1-auth word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> add custom-enc-phase1-dh-group <custom-enc-phase1-dh-group>

Parameters

Parameter Description
custom-enc-phase1- VPN Diffie-Hellman key exchange encryption level
dh-group
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add custom-enc-phase1-dh-group word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove-all custom-enc-phase1-dh-group


<custom-enc-phase1-dh-group>
Parameters

Parameter Description
custom-enc-phase1- VPN Diffie-Hellman key exchange encryption level
dh-group
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all custom-enc-phase1-dh-group word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Command Line Interface Reference Guide R77.20 Embedded | 183


Syntax set vpn site <site> remove custom-enc-phase1-dh-group <custom-enc-phase1-dh-group>

Parameters

Parameter Description
custom-enc-phase1- VPN Diffie-Hellman key exchange encryption level
dh-group
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove custom-enc-phase1-dh-group word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites
Syntax set vpn site <site> add custom-enc-phase2-enc <custom-enc-phase2-enc>

Parameters

Parameter Description
custom-enc-phase2- Encryption algorithm preferences for phase2 in the VPN encryption algorithm
enc
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add custom-enc-phase2-enc word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove-all custom-enc-phase2-enc <custom-enc-phase2-enc>

Parameters

Parameter Description
custom-enc-phase2- Encryption algorithm preferences for phase2 in the VPN encryption algorithm
enc
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all custom-enc-phase2-enc word

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 184


set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove custom-enc-phase2-enc <custom-enc-phase2-enc>

Parameters

Parameter Description
custom-enc-phase2- Encryption algorithm preferences for phase2 in the VPN encryption algorithm
enc
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove custom-enc-phase2-enc word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> add custom-enc-phase2-auth <custom-enc-phase2-auth>

Parameters

Parameter Description
custom-enc-phase2- Authentication algorithm used for encryption validation
auth
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 add custom-enc-phase2-auth word

Output Failure shows an appropriate error message.

set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove-all custom-enc-phase2-auth <custom-enc-phase2-auth>

Parameters

Parameter Description
custom-enc-phase2- Authentication algorithm used for encryption validation
auth
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove-all custom-enc-phase2-auth word

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 185


set vpn
Description Configure remote VPN sites

Syntax set vpn site <site> remove custom-enc-phase2-auth <custom-enc-phase2-auth>

Parameters

Parameter Description
custom-enc-phase2- Authentication algorithm used for encryption validation
auth
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example set vpn site site17 remove custom-enc-phase2-auth word

Output Failure shows an appropriate error message.

set vpn
Description Local network

Syntax set vpn tunnel <tunnel> type { unnumbered [ peer <peer> ] [


internet-connection <internet-connection> ] | numbered [ local <local> ] [
remote <remote> ] [ peer <peer> ] }

Parameters

Parameter Description
internet-connection The local interface for unnumbered VTI
Enter the IP address of the interface
local
Type: IP address
Remote peer name as defined in the VPN community. You must define the two
peers in the VPN community before you can define the VTI. The Peer ID is an
peer alpha-numeric character string.
Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces
Defines the remote peer IPv4 address, used at the peer gateway’s point-to-point
remote virtual interface (numbered VTI only)
Type: IP address
A number identifying the Virtual Tunnel Interface (VTI)
tunnel
Type: A number with no fractional part (integer)
The type of VTI: Numbered VTI that uses a specified, static IPv4 addresses for
local and remote connections, or unnumbered VTI that uses the interface and
type
the remote peer name to get addresses
Type: Press TAB to see available options

Example set vpn tunnel -1000000 type unnumbered peer site17 internet-connection My
connection

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 186


set vpn remote-access

VPN Remote Access

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access [ default-access-to-lan <default-access-to-lan>


] [ mode <mode> ] [ track <track> ] [ mobile-client <mobile-client> ] [
sslvpn-client <sslvpn-client> ] [ l2tp-vpn-client <l2tp-vpn-client> ] [
l2tp-pre-shared-key <l2tp-pre-shared-key> ]

Parameters

Parameter Description
Allow traffic from Remote Access clients (by default)
default-access-to-lan
Options: block, accept
L2TP Pre-Shared Key
l2tp-pre-shared-key
Type: A string of alphanumeric characters without space between them
Enable VPN remote access clients to connect via native VPN client (L2TP)
l2tp-vpn-client
Type: Boolean (true/false)
Enable VPN remote access mobile clients to connect via Check Point Mobile
mobile-client VPN client
Type: Boolean (true/false)
Enable VPN Remote Access
mode
Type: Boolean (true/false)
Enable VPN remote access clients to connect via SSL VPN
sslvpn-client
Type: Boolean (true/false)
Log traffic from Remote Access clients (by default)
track
Options: none, log

Example set vpn remote-access default-access-to-lan block mode true track none
mobile-client true sslvpn-client true l2tp-vpn-client true l2tp-pre-shared-key
word
Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings allow-caching-passwords-on-client


<allow-caching-passwords-on-client>

Parameters There are no parameters

Example set vpn remote-access advanced-settings allow-caching-passwords-on-client


true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Command Line Interface Reference Guide R77.20 Embedded | 187


Syntax set vpn remote-access advanced-settings enc-dns-traffic <enc-dns-traffic>
Parameters There are no parameters
Example set vpn remote-access advanced-settings enc-dns-traffic true
Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access
Syntax set vpn remote-access advanced-settings verify-gateway-cert
<verify-gateway-cert>
Parameters There are no parameters
Example set vpn remote-access advanced-settings verify-gateway-cert true
Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access
Syntax set vpn remote-access advanced-settings update-topo-startup
<update-topo-startup>
Parameters There are no parameters
Example set vpn remote-access advanced-settings update-topo-startup true
Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access
Syntax set vpn remote-access advanced-settings keep-alive-time <keep-alive-time>
Parameters There are no parameters
Example set vpn remote-access advanced-settings keep-alive-time -1000000
Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access
Syntax set vpn remote-access advanced-settings endpoint-vpn-user-re-auth-timeout
<endpoint-vpn-user-re-auth-timeout>
Parameters There are no parameters
Example set vpn remote-access advanced-settings endpoint-vpn-user-re-auth-timeout
-1000000
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 188


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings ike-over-tcp <ike-over-tcp>

Parameters There are no parameters

Example set vpn remote-access advanced-settings ike-over-tcp true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings is-udp-enc-active


<is-udp-enc-active>

Parameters There are no parameters


Example set vpn remote-access advanced-settings is-udp-enc-active true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings om-method-radius <om-method-radius>


Parameters There are no parameters

Example set vpn remote-access advanced-settings om-method-radius true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings snx-uninstall-on-disconnect


<snx-uninstall-on-disconnect>

Parameters There are no parameters

Example set vpn remote-access advanced-settings snx-uninstall-on-disconnect


ask-user
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 189


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings snx-keep-alive-timeout


<snx-keep-alive-timeout>

Parameters There are no parameters

Example set vpn remote-access advanced-settings snx-keep-alive-timeout -1000000

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings update-topo <update-topo>

Parameters There are no parameters


Example set vpn remote-access advanced-settings update-topo -1000000

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings use-limited-auth-timeout


<use-limited-auth-timeout>

Parameters There are no parameters

Example set vpn remote-access advanced-settings use-limited-auth-timeout true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings auth-timeout-limit


<auth-timeout-limit>

Parameters There are no parameters

Example set vpn remote-access advanced-settings auth-timeout-limit -1000000


Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 190


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings ike-support-crash-recovery


<ike-support-crash-recovery>

Parameters There are no parameters

Example set vpn remote-access advanced-settings ike-support-crash-recovery true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings enc-method <enc-method>

Parameters There are no parameters


Example set vpn remote-access advanced-settings enc-method ike-v1

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings snx-user-re-auth-timeout


<snx-user-re-auth-timeout>

Parameters There are no parameters

Example set vpn remote-access advanced-settings snx-user-re-auth-timeout -1000000

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings allow-update-topo


<allow-update-topo>

Parameters There are no parameters

Example set vpn remote-access advanced-settings allow-update-topo true


Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 191


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings om-enable-with-multiple-if


<om-enable-with-multiple-if>

Parameters There are no parameters

Example set vpn remote-access advanced-settings om-enable-with-multiple-if true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings snx-encryption-enable-rc4


<snx-encryption-enable-rc4>

Parameters There are no parameters

Example set vpn remote-access advanced-settings snx-encryption-enable-rc4 true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access
Syntax set vpn remote-access advanced-settings disconnect-enc-domain
<disconnect-enc-domain>

Parameters There are no parameters

Example set vpn remote-access advanced-settings disconnect-enc-domain true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings ike-ip-comp-support


<ike-ip-comp-support>

Parameters There are no parameters

Example set vpn remote-access advanced-settings ike-ip-comp-support true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 192


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings snx-upgrade <snx-upgrade>

Parameters There are no parameters

Example set vpn remote-access advanced-settings snx-upgrade ask-user

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings enable-back-conn <enable-back-conn>

Parameters There are no parameters

Example set vpn remote-access advanced-settings enable-back-conn true


Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings allow-clear-traffic-while-disconnected


<allow-clear-traffic-while-disconnected>
Parameters There are no parameters

Example set vpn remote-access advanced-settings allow-clear-traffic-while-disconnected


true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings prevent-ip-pool-nat


<prevent-ip-pool-nat>

Parameters There are no parameters

Example set vpn remote-access advanced-settings prevent-ip-pool-nat true


Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 193


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings disable-office-mode


<disable-office-mode>

Parameters There are no parameters

Example set vpn remote-access advanced-settings disable-office-mode true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings allow-simultaneous-login


<allow-simultaneous-login>

Parameters There are no parameters

Example set vpn remote-access advanced-settings allow-simultaneous-login true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access
Syntax set vpn remote-access advanced-settings port [ visitor-mode-port
<visitor-mode-port> ] [ reserve-port-443 <reserve-port-443> ]

Parameters There are no parameters

Example set vpn remote-access advanced-settings port visitor-mode-port 8080


reserve-port-443 true

Output Failure shows an appropriate error message.

set vpn remote-access


Description VPN Remote Access

Syntax set vpn remote-access advanced-settings office-mode [ single-om-per-site


<single-om-per-site> ] [ om-perform-antispoofing <om-perform-antispoofing> ]

Parameters There are no parameters

Example set vpn remote-access advanced-settings office-mode single-om-per-site true


om-perform-antispoofing true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 194


set vpn remote-access
Description VPN Remote Access

Syntax set vpn remote-access advanced-settings visitor-mode [ enable-visitor-mode-all


<enable-visitor-mode-all> ] [ visitor-mode-interface <visitor-mode-interface>
]

Parameters There are no parameters

Example set vpn remote-access advanced-settings visitor-mode enable-visitor-mode-all


all visitor-mode-interface 192.168.1.1

Output Failure shows an appropriate error message.

set vpn remote-access advanced

Description VPN Remote Access

Syntax set vpn remote-access advanced [ om-network-ip <om-network-ip> ] [


om-subnet-mask <om-subnet-mask> ] [ default-route-through-this-gateway
<default-route-through-this-gateway> ] [ enc-dom <enc-dom> ] [
use-this-gateway-as-dns-server <use-this-gateway-as-dns-server> ] [
dns-primary <dns-primary> ] [ dns-secondary <dns-secondary> ] [ dns-tertiary
<dns-tertiary> ] [ dns-domain-mode <dns-domain-mode> ] [ domain-name
<domain-name> ]

Parameters

Parameter Description
Indicates if Internet traffic from connected clients will be routed first through this
default-route-through- gateway
this-gateway Type: Boolean (true/false)
Indicates if remote access clients use the domain name configured under DNS
dns-domain-mode network settings of the device, or a manually configured domain name
Type: Boolean (true/false)
Configure manually office mode first DNS
dns-primary
Type: IP address
Configure manually office mode second DNS
dns-secondary
Type: IP address
Configure manually office mode third DNS
dns-tertiary
Type: IP address
Manual configuration of the domain used by remote access clients
domain-name
Type: A FQDN
Indicates if the encryption domain for remote access clients is calculated auto-
enc-dom matically or manually configured
Options: manual, auto
Office Mode - Allocate IP addresses from the following network
om-network-ip
Type: Network address
Subnet for allocating IP addresses of incoming remote access connections (Of-
om-subnet-mask fice Mode)
Type: Subnet mask
Indicates if the remote access clients will use this gateway as a DNS server.
use-this-gateway-as- Appliacable only when encryption domain is calculated automatically
dns-server Type: Boolean (true/false)

Example set vpn remote-access advanced om-network-ip 172.16.10.0 om-subnet-mask

Command Line Interface Reference Guide R77.20 Embedded | 195


255.255.255.0 default-route-through-this-gateway true enc-dom manual
use-this-gateway-as-dns-server true dns-primary 192.168.1.1 dns-secondary
192.168.1.1 dns-tertiary 192.168.1.1 dns-domain-mode true domain-name
somehost.example.com

Output Failure shows an appropriate error message.

set vpn remote-access advanced enc-dom-obj manual

VPN Remote Access

set vpn remote-access advanced enc-dom-obj manual


Description VPN Remote Access

Syntax set vpn remote-access advanced enc-dom-obj manual add name <name>

Parameters

Parameter Description
name Network Object name

Example set vpn remote-access advanced enc-dom-obj manual add name TEXT

Output Failure shows an appropriate error message.

set vpn remote-access advanced enc-dom-obj manual


Description VPN Remote Access

Syntax set vpn remote-access advanced enc-dom-obj manual remove name <name>

Parameters

Parameter Description
name Network Object name

Example set vpn remote-access advanced enc-dom-obj manual remove name TEXT

Output Failure shows an appropriate error message.

set vpn site-to-site

VPN Global

set vpn site-to-site


Description VPN Global

Command Line Interface Reference Guide R77.20 Embedded | 196


Syntax set vpn site-to-site [ mode <mode> ] [ default-access-to-lan
<default-access-to-lan> ] [ track <track> ] [ local-encryption-domain
<local-encryption-domain> ] [ manual-source-ip-address <manual-source-ip-address>
] [ sourceIpSelection <sourceIpSelection> ] [ outgoing-interface-selection
<outgoing-interface-selection> ]
Parameters

Parameter Description
default-access-to-lan Allow traffic from remote sites (by default)âĂİ
Options: block, accept
Indicates if the local encryption domain is configured manually or determined
local-encryption- automatically using the local networks
domain Options: auto, manual
A manually configured source IP address to be used (if configured to) for VPN
manual-source-ip- tunnels
address Type: IP address
Indicates whether or not VPN site to site is active
mode
Type: Boolean (true/false)
Indicates the method according to which the outgoing interface selection for
outgoing-interface- VPN traffic is chosen
selection Options: routing-table, route-based-probing
sourceIpSelection
sourceIpSelection
Options: automatically, manually
The default Logging setting for traffic from remote sites
track
Options: none, log

Example set vpn site-to-site mode true default-access-to-lan block track


none local-encryption-domain auto manual-source-ip-address 192.168.1.1
sourceIpSelection automatically outgoing-interface-selection routing-table
Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings sync-sa-with-other-cluster-members
<sync-sa-with-other-cluster-members>
Parameters There are no parameters
Example set vpn site-to-site advanced-settings sync-sa-with-other-cluster-members
-1000000
Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings keep-dont-fragment-flag-on-packet
<keep-dont-fragment-flag-on-packet>
Parameters There are no parameters
Example set vpn site-to-site advanced-settings keep-dont-fragment-flag-on-packet
true

Command Line Interface Reference Guide R77.20 Embedded | 197


Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings period-after-crl-not-valid


<period-after-crl-not-valid>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings period-after-crl-not-valid -1000000

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings log-notification-for-administrative-actions


<log-notification-for-administrative-actions>
Parameters There are no parameters

Example set vpn site-to-site advanced-settings log-notification-for-administrative-actions


none

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings udp-encapsulation-for-firewalls-and-proxies


<udp-encapsulation-for-firewalls-and-proxies>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings udp-encapsulation-for-firewalls-and-proxies


true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings copy-diff-serv-from-ipsec-packet


<copy-diff-serv-from-ipsec-packet>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings copy-diff-serv-from-ipsec-packet


true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 198


set vpn site-to-site
Description VPN Global

Syntax set vpn site-to-site advanced-settings permanent-tunnel-up-track


<permanent-tunnel-up-track>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings permanent-tunnel-up-track none

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings vpn-tunnel-sharing


<vpn-tunnel-sharing>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings vpn-tunnel-sharing hosts

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings vpn-configuration-and-key-exchange-errors
<vpn-configuration-and-key-exchange-errors>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings vpn-configuration-and-key-exchange-errors


none

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings is-admin-access-agnostic


<is-admin-access-agnostic>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings is-admin-access-agnostic true

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 199


set vpn site-to-site
Description VPN Global

Syntax set vpn site-to-site advanced-settings reply-from-incoming-interface


<reply-from-incoming-interface>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings reply-from-incoming-interface true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings log-vpn-packet-handling-errors


<log-vpn-packet-handling-errors>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings log-vpn-packet-handling-errors none

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings check-validity-of-ipsec-reply-packets
<check-validity-of-ipsec-reply-packets>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings check-validity-of-ipsec-reply-packets


true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings ike-dos-protection-unknown-sites


<ike-dos-protection-unknown-sites>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings ike-dos-protection-unknown-sites


none

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 200


set vpn site-to-site
Description VPN Global

Syntax set vpn site-to-site advanced-settings permanent-tunnel-down-track


<permanent-tunnel-down-track>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings permanent-tunnel-down-track none

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings ike-dos-protection-known-sites


<ike-dos-protection-known-sites>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings ike-dos-protection-known-sites none

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings maximum-concurrent-ike-negotiations
<maximum-concurrent-ike-negotiations>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings maximum-concurrent-ike-negotiations


-1000000

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings log-vpn-outgoing-link


<log-vpn-outgoing-link>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings log-vpn-outgoing-link none

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 201


set vpn site-to-site
Description VPN Global

Syntax set vpn site-to-site advanced-settings reply-from-same-ip


<reply-from-same-ip>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings reply-from-same-ip true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings period-before-crl-valid


<period-before-crl-valid>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings period-before-crl-valid -1000000

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings enable-link-selection
<enable-link-selection>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings enable-link-selection true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings log-vpn-successful-key-exchange


<log-vpn-successful-key-exchange>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings log-vpn-successful-key-exchange none

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 202


set vpn site-to-site
Description VPN Global

Syntax set vpn site-to-site advanced-settings limit-open-sas <limit-open-sas>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings limit-open-sas -1000000

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings timeout-for-an-rdp-packet-reply


<timeout-for-an-rdp-packet-reply>

Parameters There are no parameters


Example set vpn site-to-site advanced-settings timeout-for-an-rdp-packet-reply
-1000000

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings perform-ike-using-cluster-ip
<perform-ike-using-cluster-ip>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings perform-ike-using-cluster-ip true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global

Syntax set vpn site-to-site advanced-settings maximum-concurrent-vpn-tunnels


<maximum-concurrent-vpn-tunnels>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings maximum-concurrent-vpn-tunnels


-1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 203


set vpn site-to-site
Description VPN Global

Syntax set vpn site-to-site advanced-settings ike-use-largest-possible-subnets


<ike-use-largest-possible-subnets>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings ike-use-largest-possible-subnets


true

Output Failure shows an appropriate error message.

set vpn site-to-site


Description VPN Global
Syntax set vpn site-to-site advanced-settings copy-diff-serv-to-ipsec-packet
<copy-diff-serv-to-ipsec-packet>

Parameters There are no parameters

Example set vpn site-to-site advanced-settings copy-diff-serv-to-ipsec-packet true

Output Failure shows an appropriate error message.

set vpn site-to-site enc-dom manual

VPN Global

set vpn site-to-site enc-dom manual


Description VPN Global

Syntax set vpn site-to-site enc-dom manual add name <name>

Parameters

Parameter Description
name Network Object name

Example set vpn site-to-site enc-dom manual add name TEXT

Output Failure shows an appropriate error message.

set vpn site-to-site enc-dom manual


Description VPN Global

Syntax set vpn site-to-site enc-dom manual remove-all name <name>

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 204


Parameter Description
name Network Object name

Example set vpn site-to-site enc-dom manual remove-all name TEXT

Output Failure shows an appropriate error message.

set vpn site-to-site enc-dom manual


Description VPN Global

Syntax set vpn site-to-site enc-dom manual remove name <name>

Parameters

Parameter Description
name Network Object name

Example set vpn site-to-site enc-dom manual remove name TEXT

Output Failure shows an appropriate error message.

set wlan

Virtual Access Point

set wlan
Description Virtual Access Point

Syntax set wlan { enable | disable }

Parameters

Parameter Description
The mode of the Virtual Access Point
mode
Options: on, off

Example set wlan on

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan ssid <ssid>

Parameters

Parameter Description

Command Line Interface Reference Guide R77.20 Embedded | 205


Wireless network name (SSID)
ssid
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and space characters

Example set wlan ssid My wireless

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan security-type <security-type>


Parameters

Parameter Description
Security Type
security-type
Options: none, WEP, WPA2, WPA/WPA2

Example set wlan security-type none

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan wpa-auth-type password <password> [ hotspot <hotspot > ]

Parameters There are no parameters

Example set wlan wpa-auth-type password gTd&3(gha_ hotspot on

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan wpa-auth-type { radius [ hotspot <hotspot > ] }

Parameters

Parameter Description
The Hotspot of the Virtual Access Point
hotspot
Options: on, off
Wireless protected access authentication
wpa-auth-type
Type: Press TAB to see available options

Example set wlan wpa-auth-type radius hotspot on

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 206


set wlan
Description Virtual Access Point

Syntax set wlan wpa-encryption-type <wpa-encryption-type>

Parameters

Parameter Description
Wireless protected access encryption type
wpa-encryption-type
Options: Auto, CCMP-AES, TKIP

Example set wlan wpa-encryption-type Auto

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan assignment <assignment>

Parameters

Parameter Description
The network assigned to the virtual access point
assignment
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set wlan assignment My_Network

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan advanced-settings [ hide-ssid <hide-ssid> ] [ station-to-station


<station-to-station> ] [ wds <wds> ]

Parameters There are no parameters

Example set wlan advanced-settings hide-ssid on station-to-station allow wds on

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> { enable | disable }

Parameters

Parameter Description
The mode of the Virtual Access Point
mode
Options: on, off
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Command Line Interface Reference Guide R77.20 Embedded | 207


Example set wlan vap My_Network on

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> ssid <ssid>

Parameters

Parameter Description
Wireless network name (SSID)
ssid
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and space characters
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set wlan vap My_Network ssid My wireless

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> security-type <security-type>

Parameters

Parameter Description
Security Type
security-type
Options: none, WEP, WPA2, WPA/WPA2
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set wlan vap My_Network security-type none

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> wpa-auth-type password <password> [ hotspot <hotspot > ]

Parameters

Parameter Description
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set wlan vap My_Network wpa-auth-type password gTd&3(gha_ hotspot on

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 208


set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> wpa-auth-type { radius [ hotspot <hotspot > ] }

Parameters

Parameter Description
The Hotspot of the Virtual Access Point
hotspot
Options: on, off
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
Wireless protected access authentication
wpa-auth-type
Type: Press TAB to see available options

Example set wlan vap My_Network wpa-auth-type radius hotspot on

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> wpa-encryption-type <wpa-encryption-type>


Parameters

Parameter Description
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
Wireless protected access encryption type
wpa-encryption-type
Options: Auto, CCMP-AES, TKIP

Example set wlan vap My_Network wpa-encryption-type Auto

Output Failure shows an appropriate error message.

set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> assignment <assignment>

Parameters

Parameter Description
The network assigned to the virtual access point
assignment
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set wlan vap My_Network assignment My_Network

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 209


set wlan
Description Virtual Access Point

Syntax set wlan vap <vap> advanced-settings [ hide-ssid <hide-ssid> ] [


station-to-station <station-to-station> ] [ wds <wds> ]

Parameters

Parameter Description
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example set wlan vap My_Network advanced-settings hide-ssid on station-to-station


allow wds on

Output Failure shows an appropriate error message.

set wlan radio

Wireless networks

set wlan radio


Description Wireless networks

Syntax set wlan radio [ country <country> ] [ operation-mode <operation-mode> ]


[ channel <channel> ] [ channel-width <channel-width> ] [ transmitter-power
<transmitter-power> ]

Parameters

Parameter Description
Channel
channel
Options: auto, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
Channel width
channel-width
Options: auto, 20
Country
country
Options: country
Operation mode
operation-mode
Options: 11b, 11g, 11bg, 11n, 11ng
Controls the range of the wireless access point. Lower power can help reduce
transmitter-power interference to nearby access points
Options: minimum, eighth, quarter, half, full

Example set wlan radio country albania operation-mode 11b channel auto
channel-width auto transmitter-power minimum

Output Failure shows an appropriate error message.

set wlan radio


Description Wireless networks

Command Line Interface Reference Guide R77.20 Embedded | 210


Syntax set wlan radio { off | on }

Parameters

Parameter Description
Wireless radio mode
mode
Options: off, on

Example set wlan radio off

Output Failure shows an appropriate error message.

set wlan radio


Description Wireless networks

Syntax set wlan radio advanced-settings transmitter-power <transmitter-power>

Parameters There are no parameters

Example set wlan radio advanced-settings transmitter-power minimum

Output Failure shows an appropriate error message.

set wlan radio


Description Wireless networks

Syntax set wlan radio advanced-settings antenna <antenna>

Parameters There are no parameters

Example set wlan radio advanced-settings antenna auto

Output Failure shows an appropriate error message.

set wlan radio


Description Wireless networks
Syntax set wlan radio advanced-settings guard-interval <guard-interval>

Parameters There are no parameters

Example set wlan radio advanced-settings guard-interval short

Output Failure shows an appropriate error message.

show access-rule type incoming-internal-and-vpn

Access rule

Command Line Interface Reference Guide R77.20 Embedded | 211


show access-rule type incoming-internal-and-vpn
Description Access rule

Syntax show access-rule type incoming-internal-and-vpn position <position> position


<position>

Parameters

Parameter Description
The order of a manual rule in comparison to other manual rules
position
Type: Decimal number

Example show access-rule type incoming-internal-and-vpn position 2 position 2

Output Failure shows an appropriate error message.

show access-rule type incoming-internal-and-vpn


Description Access rule

Syntax show access-rule type incoming-internal-and-vpn name <name> position


<position>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them
The order of a manual rule in comparison to other manual rules
position
Type: Decimal number

Example show access-rule type incoming-internal-and-vpn name word position 2

Output Failure shows an appropriate error message.

show access-rule type outgoing

Access rule

show access-rule type outgoing


Description Access rule

Syntax show access-rule type outgoing name <name> position <position>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them
The order of a manual rule in comparison to other manual rules
position
Type: Decimal number

Command Line Interface Reference Guide R77.20 Embedded | 212


Example show access-rule type outgoing name word position 2

Output Failure shows an appropriate error message.

show access-rule type outgoing


Description Access rule

Syntax show access-rule type outgoing position <position> position <position>

Parameters

Parameter Description
The order of a manual rule in comparison to other manual rules
position
Type: Decimal number

Example show access-rule type outgoing position 2 position 2

Output Failure shows an appropriate error message.

show access-rules type incoming-internal-and-vpn

Description Access rule

Syntax show access-rules type incoming-internal-and-vpn position <position>

Parameters

Parameter Description
The order of a manual rule in comparison to other manual rules
position
Type: Decimal number

Example show access-rules type incoming-internal-and-vpn position 2

Output Failure shows an appropriate error message.

show access-rules type outgoing

Description Access rule

Syntax show access-rules type outgoing position <position>

Parameters

Parameter Description
The order of a manual rule in comparison to other manual rules
position
Type: Decimal number

Example show access-rules type outgoing position 2

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 213


show ad-server

Description Active directory server object

Syntax show ad-server <domain>

Parameters

Parameter Description
Domain name
domain
Type: Host name

Example show ad-server myHost.com

Output Failure shows an appropriate error message.

show ad-servers

Description Active directory server object

Syntax show ad-servers

Parameters There are no parameters

Example show ad-servers

Output Failure shows an appropriate error message.

show additional-hw-settings

Description Additional hardware and operating system settings

Syntax show additional-hw-settings

Parameters There are no parameters

Example show additional-hw-settings

Output Failure shows an appropriate error message.

show address-range

Description Address range object

Syntax show address-range <name>

Parameters

Parameter Description
Network Object name
name
Type: String

Command Line Interface Reference Guide R77.20 Embedded | 214


Example show address-range TEXT

Output Failure shows an appropriate error message.

show address-ranges

Description Address range object

Syntax show address-ranges

Parameters There are no parameters

Example show address-ranges

Output Failure shows an appropriate error message.

show admin-access

Description Administrator access

Syntax show admin-access

Parameters There are no parameters

Example show admin-access

Output Failure shows an appropriate error message.

show admin-access-ipv4-addresses

Description Administrator access IP addresses

Syntax show admin-access-ipv4-addresses

Parameters There are no parameters

Example show admin-access-ipv4-addresses

Output Failure shows an appropriate error message.

show administrator

Description Configured administrator for the appliance

Syntax show administrator username <username>

Parameters

Parameter Description
Indicates the administrator user name
username
Type: A string that contains [A-Z], [0-9], and ’_’ characters

Command Line Interface Reference Guide R77.20 Embedded | 215


Example show administrator username admin

Output Failure shows an appropriate error message.

show administrator session-settings

Description Limit administrators login failure attempts for before locking out for a defined period of time

Syntax show administrator session-settings

Parameters There are no parameters

Example show administrator session-settings

Output Failure shows an appropriate error message.

show administrators

Description Configured administrator for the appliance

Syntax show administrators

Parameters There are no parameters

Example show administrators

Output Failure shows an appropriate error message.

show administrators radius-auth

Description Administrators RADIUS authentication

Syntax show administrators radius-auth

Parameters There are no parameters

Example show administrators radius-auth

Output Failure shows an appropriate error message.

show adsl statistics

Description ADSL information

Syntax show adsl statistics

Parameters There are no parameters

Example show adsl statistics

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 216


show aggressive-aging

Connections aggressive aging

show aggressive-aging
Description Connections aggressive aging
Syntax show aggressive-aging
Parameters There are no parameters
Example show aggressive-aging
Output Failure shows an appropriate error message.

show aggressive-aging
Description Connections aggressive aging
Syntax show aggressive-aging advanced-settings
Parameters There are no parameters
Example show aggressive-aging advanced-settings
Output Failure shows an appropriate error message.

show antispam

Policy for Anti-Spam blade

show antispam
Description Policy for Anti-Spam blade
Syntax show antispam
Parameters There are no parameters
Example show antispam
Output Failure shows an appropriate error message.

show antispam
Description Policy for Anti-Spam blade
Syntax show antispam advanced-settings
Parameters There are no parameters
Example show antispam advanced-settings
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 217


show antispam allowed-senders

Description List of allowed IP addresses, email addresses (senders) and domains for Anti-Spam blade

Syntax show antispam allowed-senders

Parameters There are no parameters

Example show antispam allowed-senders

Output Failure shows an appropriate error message.

show antispam blocked-senders

Description List of blocked IP addresses, email addresses (senders) and domains for Anti-Spam blade

Syntax show antispam blocked-senders

Parameters There are no parameters

Example show antispam blocked-senders

Output Failure shows an appropriate error message.

show application

Application

show application
Description Application
Syntax show application application-name <application-name>

Parameters

Parameter Description
Application or group name
application-name
Type: String

Example show application application-name TEXT

Output Failure shows an appropriate error message.

show application
Description Application

Syntax show application application-id <application-id>

Parameters

Command Line Interface Reference Guide R77.20 Embedded | 218


Parameter Description
The ID of the application or the group
application-id
Type: A number with no fractional part (integer)

Example show application application-id -1000000

Output Failure shows an appropriate error message.

show application-control

Description Default APPI policy and configuration

Syntax show application-control

Parameters There are no parameters

Example show application-control

Output Failure shows an appropriate error message.

show application-control other-undesired-applications

Description User defined application group

Syntax show application-control other-undesired-applications

Parameters There are no parameters

Example show application-control other-undesired-applications

Output Failure shows an appropriate error message.

show application-group

User defined application group

show application-group
Description User defined application group

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

Parameters

Parameter Description
The ID of the application group
application-group-id
Type: A number with no fractional part (integer)

Example show application-group application-group-id -1000000


Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 219


show application-group
Description User defined application group

Syntax show application-group name <name>

Parameters

Parameter Description
Application group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - . &) characters without spaces

Example show application-group name users

Output Failure shows an appropriate error message.

show application-groups

Description User defined application group

Syntax show application-groups

Parameters There are no parameters

Example show application-groups

Output Failure shows an appropriate error message.

show applications

Description Application

Syntax show applications

Parameters There are no parameters

Example show applications

Output Failure shows an appropriate error message.

show bridge

Description Bridge configured in the device

Syntax show bridge <name>

Parameters

Parameter Description
Bridge name
name
Type: A bridge name can be br0-9

Command Line Interface Reference Guide R77.20 Embedded | 220


Example show bridge br7

Output Failure shows an appropriate error message.

show bridges

Description Bridge configured in the device

Syntax show bridges

Parameters There are no parameters

Example show bridges

Output Failure shows an appropriate error message.

show cloud-deployment

Description Cloud Deployment Settings

Syntax show cloud-deployment

Parameters There are no parameters

Example show cloud-deployment

Output Failure shows an appropriate error message.

show cloud-services

Description Cloud Services

Syntax show cloud-services advanced-settings

Parameters There are no parameters

Example show cloud-services advanced-settings

Output Failure shows an appropriate error message.

show cloud-services connection-details

Description Cloud Services

Syntax show cloud-services connection-details

Parameters There are no parameters

Example show cloud-services connection-details

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 221


show cloud-services managed-blades

Description Table for activation status of a blade

Syntax show cloud-services managed-blades

Parameters There are no parameters

Example show cloud-services managed-blades

Output Failure shows an appropriate error message.

show cloud-services managed-services

Description Cloud services managed by the provider

Syntax show cloud-services managed-services

Parameters There are no parameters

Example show cloud-services managed-services

Output Failure shows an appropriate error message.

show cloud-services status

Description Status of current connection to the cloud services provider

Syntax show cloud-services status


Parameters There are no parameters

Example show cloud-services status

Output Failure shows an appropriate error message.

show date

Manual time

show date
Description Manual time

Syntax show date

Parameters There are no parameters

Example show date

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 222


show date
Description Manual time

Syntax show time

Parameters There are no parameters

Example show time

Output Failure shows an appropriate error message.

show date
Description Manual time

Syntax show timezone

Parameters There are no parameters

Example show timezone


Output Failure shows an appropriate error message.

show date
Description Manual time

Syntax show timezone-dst

Parameters There are no parameters

Example show timezone-dst


Output Failure shows an appropriate error message.

show device-details

Description Device details

Syntax show device-details

Parameters There are no parameters

Example show device-details

Output Failure shows an appropriate error message.

show dhcp server interface

Local network

Command Line Interface Reference Guide R77.20 Embedded | 223


show dhcp server interface
Description Local network

Syntax show dhcp server interface <name>

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example show dhcp server interface My_Network

Output Failure shows an appropriate error message.

show dhcp server interface


Description Local network

Syntax show dhcp server interface <name> ip-pool

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example show dhcp server interface My_Network ip-pool


Output Failure shows an appropriate error message.

show dhcp servers

Description Local network


Syntax show dhcp servers
Parameters There are no parameters
Example show dhcp servers
Output Failure shows an appropriate error message.

show dhcp servers table

Description Local network


Syntax show dhcp servers table
Parameters There are no parameters
Example show dhcp servers table
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 224


show dhcp-relay

Description DHCP Relay advanced options

Syntax show dhcp-relay advanced-settings

Parameters There are no parameters

Example show dhcp-relay advanced-settings

Output Failure shows an appropriate error message.

show dns

Configure DNS and Domain settings for the device

show dns
Description Configure DNS and Domain settings for the device

Syntax show dns

Parameters There are no parameters

Example show dns

Output Failure shows an appropriate error message.

show dns
Description Configure DNS and Domain settings for the device

Syntax show dns [ primary ipv4-address ] [ secondary ipv4-address ] [ tertiary


ipv4-address ] [ mode ] [ proxy ]

Parameters There are no parameters

Example show dns primary ipv4-address secondary ipv4-address tertiary ipv4-address


mode proxy

Output Failure shows an appropriate error message.

show dns
Description Configure DNS and Domain settings for the device

Syntax show domainname

Parameters There are no parameters

Example show domainname

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 225


show dynamic-dns

Description Configure a persistent domain name for the device

Syntax show dynamic-dns

Parameters There are no parameters

Example show dynamic-dns

Output Failure shows an appropriate error message.

show fw policy

Default policy for firewall blade

show fw policy
Description Default policy for firewall blade

Syntax show fw policy

Parameters There are no parameters

Example show fw policy

Output Failure shows an appropriate error message.

show fw policy
Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

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

Parameters

Parameter Description
Activity message type
user-check
Type: Press TAB to see available options

Example show fw policy user-check block


Output Failure shows an appropriate error message.

show group

Description Network Objects Group model


Syntax show group <name>
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 226


Parameter Description
Network Object group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example show group myObject_17

Output Failure shows an appropriate error message.

show groups

Description Network Objects Group model

Syntax show groups

Parameters There are no parameters

Example show groups

Output Failure shows an appropriate error message.

show host

Description Address range object

Syntax show host <name>

Parameters

Parameter Description
Network Object name
name
Type: String

Example show host TEXT

Output Failure shows an appropriate error message.

show hosts

Description Address range object

Syntax show hosts

Parameters There are no parameters

Example show hosts

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 227


show hotspot

Hotspot settings

show hotspot
Description Hotspot settings

Syntax show hotspot

Parameters There are no parameters

Example show hotspot

Output Failure shows an appropriate error message.

show hotspot
Description Hotspot settings

Syntax show hotspot advanced-settings

Parameters There are no parameters

Example show hotspot advanced-settings

Output Failure shows an appropriate error message.

show https-categorization

Description HTTPS categorization

Syntax show https-categorization advanced-settings

Parameters There are no parameters

Example show https-categorization advanced-settings

Output Failure shows an appropriate error message.

show interface

Description Local network


Syntax show interface <name> [ all ]

Parameters

Parameter Description
Network name
name
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example show interface My_Network all

Command Line Interface Reference Guide R77.20 Embedded | 228


Output Failure shows an appropriate error message.

show interfaces

Description Local network

Syntax show interfaces

Parameters There are no parameters

Example show interfaces

Output Failure shows an appropriate error message.

show interfaces all

Description Local network

Syntax show interfaces all

Parameters There are no parameters

Example show interfaces all

Output Failure shows an appropriate error message.

show interfaces table

Description Local network

Syntax show interfaces table

Parameters There are no parameters

Example show interfaces table

Output Failure shows an appropriate error message.

show internet

Description Global settings that affect all internet connections

Syntax show internet advanced-settings

Parameters There are no parameters

Example show internet advanced-settings

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 229


show internet mode

Description Traffic will be distributed automatically across the defined Internet connections according to the con-
figured load balancing weights

Syntax show internet mode

Parameters There are no parameters

Example show internet mode

Output Failure shows an appropriate error message.

show internet-connection

Internet Connection

show internet-connection
Description Internet Connection

Syntax show internet-connection <name>

Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Example show internet-connection My connection

Output Failure shows an appropriate error message.

show internet-connection
Description Internet Connection

Syntax show internet-connection <name> icmp-servers

Parameters

Parameter Description
Connection name
name
Type: A string that contains [A-Z], [0-9], ’-’, ’@’, ’.’, ’_’ and space characters

Example show internet-connection My connection icmp-servers


Output Failure shows an appropriate error message.

show internet-connections

Description Internet Connection

Command Line Interface Reference Guide R77.20 Embedded | 230


Syntax show internet-connections

Parameters There are no parameters

Example show internet-connections

Output Failure shows an appropriate error message.

show internet-connections table

Description Internet Connection

Syntax show internet-connections table

Parameters There are no parameters


Example show internet-connections table

Output Failure shows an appropriate error message.

show ip-fragments-params

Description IP fragments parameters

Syntax show ip-fragments-params advanced-settings

Parameters There are no parameters

Example show ip-fragments-params advanced-settings

Output Failure shows an appropriate error message.

show ips engine-settings

IPS engine settings

show ips engine-settings


Description IPS engine settings

Syntax show ips engine-settings

Parameters There are no parameters

Example show ips engine-settings

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 231


show ips engine-settings
Description IPS engine settings

Syntax show ips engine-settings advanced-settings

Parameters There are no parameters

Example show ips engine-settings advanced-settings

Output Failure shows an appropriate error message.

show local-group

Description Local Users Group

Syntax show local-group name <name>

Parameters

Parameter Description
Local group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example show local-group name myObject_17

Output Failure shows an appropriate error message.

show local-groups

Description Local Users Group

Syntax show local-groups

Parameters There are no parameters

Example show local-groups

Output Failure shows an appropriate error message.

show local-user

Description Configure a local database of users

Syntax show local-user name <name>

Parameters

Parameter Description
User’s name in the local database
name
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Command Line Interface Reference Guide R77.20 Embedded | 232


Example show local-user name admin

Output Failure shows an appropriate error message.

show local-users

Description Configure a local database of users

Syntax show local-users

Parameters There are no parameters

Example show local-users

Output Failure shows an appropriate error message.

show log-servers-configuration

Description Log servers configuration

Syntax show log-servers-configuration

Parameters There are no parameters

Example show log-servers-configuration

Output Failure shows an appropriate error message.

show loginMessages

loginMessages

show loginMessages
Description loginMessages

Syntax show loginMessages <type>

Parameters

Parameter Description
type
type
Options: motd, banner, caption

Example show loginMessages motd


Output Failure shows an appropriate error message.

show loginMessages
Description loginMessages

Command Line Interface Reference Guide R77.20 Embedded | 233


Syntax show loginMessages <type> [ enabled ]

Parameters

Parameter Description
type
type
Options: motd, banner, caption

Example show loginMessages motd enabled

Output Failure shows an appropriate error message.

show nat

NAT global

show nat
Description NAT global

Syntax show nat

Parameters There are no parameters

Example show nat

Output Failure shows an appropriate error message.

show nat
Description NAT global

Syntax show nat advanced-settings

Parameters There are no parameters

Example show nat advanced-settings

Output Failure shows an appropriate error message.

show nat-rule

Description Manual NAT rules

Syntax show nat-rule name <name> position <position>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Command Line Interface Reference Guide R77.20 Embedded | 234


Example show nat-rule name word position 2

Output Failure shows an appropriate error message.

show nat-rule position

Description Manual NAT rules

Syntax show nat-rule position <position> position <position>

Parameters

Parameter Description
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Example show nat-rule position 2 position 2

Output Failure shows an appropriate error message.

show nat-rules

Description Manual NAT rules

Syntax show nat-rules position <position>

Parameters

Parameter Description
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Example show nat-rules position 2

Output Failure shows an appropriate error message.

show netflow collector

Description Netflow object table

Syntax show netflow collector ip <ip> port <port>

Parameters

Parameter Description
IP address
ip
Type: IP address
UDP port
port
Type: Port number

Example show netflow collector ip 192.168.1.1 port 8080

Command Line Interface Reference Guide R77.20 Embedded | 235


Output Failure shows an appropriate error message.

show netflow collectors

Description Netflow object table

Syntax show netflow collectors

Parameters There are no parameters

Example show netflow collectors

Output Failure shows an appropriate error message.

show network

Description Address range object

Syntax show network <name>

Parameters

Parameter Description
Network Object name
name
Type: String

Example show network TEXT


Output Failure shows an appropriate error message.

show networks

Description Address range object


Syntax show networks
Parameters There are no parameters
Example show networks
Output Failure shows an appropriate error message.

show ntp

Description NTP
Syntax show ntp
Parameters There are no parameters
Example show ntp
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 236


show ntp active

Description NTP

Syntax show ntp active

Parameters There are no parameters

Example show ntp active

Output Failure shows an appropriate error message.

show ntp servers

Description NTP

Syntax show ntp servers

Parameters There are no parameters

Example show ntp servers

Output Failure shows an appropriate error message.

show proxy

Description Configure proxy settings for connecting with Check Point update and license servers

Syntax show proxy


Parameters There are no parameters

Example show proxy

Output Failure shows an appropriate error message.

show qos

QoS blade basic configuration

show qos
Description QoS blade basic configuration

Syntax show qos

Parameters There are no parameters

Example show qos

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 237


show qos
Description QoS blade basic configuration

Syntax show qos advanced-settings

Parameters There are no parameters

Example show qos advanced-settings

Output Failure shows an appropriate error message.

show qos delay-sensitive-services

Description A group of services

Syntax show qos delay-sensitive-services

Parameters There are no parameters

Example show qos delay-sensitive-services

Output Failure shows an appropriate error message.

show qos guarantee-bandwidth-selected-services

Description A group of services

Syntax show qos guarantee-bandwidth-selected-services

Parameters There are no parameters

Example show qos guarantee-bandwidth-selected-services

Output Failure shows an appropriate error message.

show qos-rule

QoS rule base rule configuration

show qos-rule
Description QoS rule base rule configuration

Syntax show qos-rule idx <idx> position <position>

Parameters

Parameter Description
The order of the rule in comparison to other manual rules
idx
Type: Decimal number
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Command Line Interface Reference Guide R77.20 Embedded | 238


Example show qos-rule idx 3.141 position 2

Output Failure shows an appropriate error message.

show qos-rule
Description QoS rule base rule configuration

Syntax show qos-rule name <name> position <position>

Parameters

Parameter Description
name
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other manual rules
position
Type: Decimal number

Example show qos-rule name word position 2

Output Failure shows an appropriate error message.

show qos-rules

Description View for QoS rule base


Syntax show qos-rules position <position>

Parameters

Parameter Description
The order of the rule in the rule base
position
Type: Decimal number

Example show qos-rules position 2

Output Failure shows an appropriate error message.

show radius-server

Description Users RADIUS server

Syntax show radius-server priority <priority>

Parameters

Parameter Description
Priority of the choose tab, can be primary or secondary
priority
Type: A number with no fractional part (integer)

Example show radius-server priority -1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 239


show radius-servers

Description Users RADIUS server

Syntax show radius-servers

Parameters There are no parameters

Example show radius-servers

Output Failure shows an appropriate error message.

show reach-my-device

Reach My Device

show reach-my-device
Description Reach My Device

Syntax show reach-my-device

Parameters There are no parameters

Example show reach-my-device

Output Failure shows an appropriate error message.

show reach-my-device
Description Reach My Device

Syntax show reach-my-device advanced-settings

Parameters There are no parameters

Example show reach-my-device advanced-settings

Output Failure shows an appropriate error message.

show remote-access users radius-auth

Description VPN Remote Access

Syntax show remote-access users radius-auth

Parameters There are no parameters

Example show remote-access users radius-auth

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 240


show security-management

Description Security management settings

Syntax show security-management

Parameters There are no parameters

Example show security-management

Output Failure shows an appropriate error message.

show serial-port

Description Serial port

Syntax show serial-port

Parameters There are no parameters

Example show serial-port

Output Failure shows an appropriate error message.

show server

Description Server network object

Syntax show server <name>


Parameters

Parameter Description
Server object name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example show server myObject_17

Output Failure shows an appropriate error message.

show servers

Description Server network object

Syntax show servers

Parameters There are no parameters

Example show servers

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 241


show service-group

Description A group of services

Syntax show service-group <name>

Parameters

Parameter Description
Service Group name
name Type: A string that begins with a letter and contain up to 32 alphanumeric (0-9,
a-z, _ - .) characters without spaces

Example show service-group myObject_17

Output Failure shows an appropriate error message.

show service-groups

Description A group of services

Syntax show service-groups

Parameters There are no parameters

Example show service-groups


Output Failure shows an appropriate error message.

show service-icmp

Description Service objects

Syntax show service-icmp <name>

Parameters

Parameter Description
Service name
name
Type: String

Example show service-icmp TEXT


Output Failure shows an appropriate error message.

show service-protocol

Description Service objects


Syntax show service-protocol <name>
Parameters

Command Line Interface Reference Guide R77.20 Embedded | 242


Parameter Description
Service name
name
Type: String

Example show service-protocol TEXT

Output Failure shows an appropriate error message.

show service-tcp

Description Service objects

Syntax show service-tcp <name>

Parameters

Parameter Description
Service name
name
Type: String

Example show service-tcp TEXT

Output Failure shows an appropriate error message.

show service-udp

Description Service objects

Syntax show service-udp <name>

Parameters

Parameter Description
Service name
name
Type: String

Example show service-udp TEXT

Output Failure shows an appropriate error message.

show services-icmp

Description Service objects

Syntax show services-icmp

Parameters There are no parameters

Example show services-icmp

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 243


show services-protocol

Description Service objects

Syntax show services-protocol

Parameters There are no parameters

Example show services-protocol

Output Failure shows an appropriate error message.

show services-tcp

Description Service objects

Syntax show services-tcp

Parameters There are no parameters

Example show services-tcp

Output Failure shows an appropriate error message.

show services-udp

Description Service objects

Syntax show services-udp


Parameters There are no parameters

Example show services-udp

Output Failure shows an appropriate error message.

show snmp

SNMP version3 user configuration options for: security level, authentication settings and passwords

show snmp
Description SNMP version3 user configuration options for: security level, authentication settings and passwords

Syntax show snmp user <user>

Parameters

Parameter Description
version3 user name
user
Type: A string that contains (0-9, a-z, - . @) up to 64 characters without spaces

Command Line Interface Reference Guide R77.20 Embedded | 244


Example show snmp user admin

Output Failure shows an appropriate error message.

show snmp
Description SNMP general configuration options

Syntax show snmp agent

Parameters There are no parameters

Example show snmp agent

Output Failure shows an appropriate error message.

show snmp
Description SNMP general configuration options

Syntax show snmp agent-version

Parameters There are no parameters

Example show snmp agent-version

Output Failure shows an appropriate error message.

show snmp
Description SNMP general configuration options

Syntax show snmp community

Parameters There are no parameters

Example show snmp community

Output Failure shows an appropriate error message.

show snmp
Description SNMP general configuration options

Syntax show snmp contact

Parameters There are no parameters

Example show snmp contact

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 245


show snmp
Description SNMP general configuration options

Syntax show snmp location

Parameters There are no parameters

Example show snmp location

Output Failure shows an appropriate error message.

show snmp traps

Description SNMP general configuration options

Syntax show snmp traps status

Parameters There are no parameters

Example show snmp traps status

Output Failure shows an appropriate error message.

show snmp traps enabled-traps

Description Configure, enable or disable traps from the list, the enabled traps are sent to the trap receivers

Syntax show snmp traps enabled-traps

Parameters There are no parameters

Example show snmp traps enabled-traps

Output Failure shows an appropriate error message.

show snmp traps receivers

Description Configured destinations to receive traps sent by the SNMP agent, a trap is an SNMP agent’s way of
notifying the manager that something is wrong

Syntax show snmp traps receivers

Parameters There are no parameters

Example show snmp traps receivers

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 246


show snmp users

Description SNMP version3 user configuration options for: security level, authentication settings and passwords

Syntax show snmp users

Parameters There are no parameters

Example show snmp users

Output Failure shows an appropriate error message.

show snmp-general-all

Description SNMP general configuration options

Syntax show snmp-general-all


Parameters There are no parameters

Example show snmp-general-all

Output Failure shows an appropriate error message.

show static-routes

Description Static routes

Syntax show static-routes

Parameters There are no parameters

Example show static-routes

Output Failure shows an appropriate error message.

show static-routes table

Description Static routes

Syntax show static-routes table

Parameters There are no parameters


Example show static-routes table

Output Failure shows an appropriate error message.

show streaming-engine-settings

Streaming engine settings

Command Line Interface Reference Guide R77.20 Embedded | 247


show streaming-engine-settings
Description Streaming engine settings

Syntax show streaming-engine-settings

Parameters There are no parameters

Example show streaming-engine-settings

Output Failure shows an appropriate error message.

show streaming-engine-settings
Description Streaming engine settings

Syntax show streaming-engine-settings advanced-settings

Parameters There are no parameters

Example show streaming-engine-settings advanced-settings


Output Failure shows an appropriate error message.

show switch

Switch

show switch
Description Switch

Syntax show switch <name>

Parameters

Parameter Description
Name
name
Type: A switch name can be LAN[1-8]_Switch

Example show switch LAN2_Switch

Output Failure shows an appropriate error message.

show switch
Description Switch

Syntax show switch <name> ports

Parameters

Parameter Description
Name
name
Type: A switch name can be LAN[1-8]_Switch

Command Line Interface Reference Guide R77.20 Embedded | 248


Example show switch LAN2_Switch ports
Output Failure shows an appropriate error message.

show switches

Description Switch
Syntax show switches
Parameters There are no parameters
Example show switches
Output Failure shows an appropriate error message.

show threat-prevention anti-bot engine

Description Anti-Bot engine


Syntax show threat-prevention anti-bot engine
Parameters There are no parameters
Example show threat-prevention anti-bot engine
Output Failure shows an appropriate error message.

show threat-prevention anti-bot policy

Threat Prevention Anti-Bot policy

show threat-prevention anti-bot policy


Description Threat Prevention Anti-Bot policy
Syntax show threat-prevention anti-bot policy
Parameters There are no parameters
Example show threat-prevention anti-bot policy
Output Failure shows an appropriate error message.

show threat-prevention anti-bot policy


Description Threat Prevention Anti-Bot policy
Syntax show threat-prevention anti-bot policy advanced-settings
Parameters There are no parameters
Example show threat-prevention anti-bot policy advanced-settings
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 249


show threat-prevention anti-bot user-check ask

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax show threat-prevention anti-bot user-check ask

Parameters There are no parameters

Example show threat-prevention anti-bot user-check ask

Output Failure shows an appropriate error message.

show threat-prevention anti-bot user-check block

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax show threat-prevention anti-bot user-check block

Parameters There are no parameters

Example show threat-prevention anti-bot user-check block


Output Failure shows an appropriate error message.

show threat-prevention anti-virus engine

Description Anti-Virus engine

Syntax show threat-prevention anti-virus engine

Parameters There are no parameters

Example show threat-prevention anti-virus engine

Output Failure shows an appropriate error message.

show threat-prevention anti-virus file-type

Description Manage Anti-Virus policy per file type

Syntax show threat-prevention anti-virus file-type extension <extension>

Parameters

Parameter Description
File extension that represents this file type
extension Type: A string that contains less than 257 characters, of this set: 0-9, a-z or , . -
: () @

Example show threat-prevention anti-virus file-type extension This is a comment.

Command Line Interface Reference Guide R77.20 Embedded | 250


Output Failure shows an appropriate error message.

show threat-prevention anti-virus file-types

Description Manage Anti-Virus policy per file type


Syntax show threat-prevention anti-virus file-types
Parameters There are no parameters
Example show threat-prevention anti-virus file-types
Output Failure shows an appropriate error message.

show threat-prevention anti-virus policy

Threat Prevention Anti-Virus policy

show threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy
Syntax show threat-prevention anti-virus policy
Parameters There are no parameters
Example show threat-prevention anti-virus policy
Output Failure shows an appropriate error message.

show threat-prevention anti-virus policy


Description Threat Prevention Anti-Virus policy
Syntax show threat-prevention anti-virus policy advanced-settings
Parameters There are no parameters
Example show threat-prevention anti-virus policy advanced-settings
Output Failure shows an appropriate error message.

show threat-prevention anti-virus user-check ask

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action
Syntax show threat-prevention anti-virus user-check ask
Parameters There are no parameters
Example show threat-prevention anti-virus user-check ask
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 251


show threat-prevention anti-virus user-check block

Description User Check is a customizable message shown to users upon match, and allows to ’ask’ the user for
the desired action

Syntax show threat-prevention anti-virus user-check block

Parameters There are no parameters

Example show threat-prevention anti-virus user-check block

Output Failure shows an appropriate error message.

show threat-prevention exception

Description Malware exceptions

Syntax show threat-prevention exception name <name> position <position>

Parameters

Parameter Description
The name of the exception
name
Type: A string of alphanumeric characters without space between them
The order of the rule in comparison to other rules
position
Type: Decimal number

Example show threat-prevention exception name word position 2

Output Failure shows an appropriate error message.

show threat-prevention exception position

Description Malware exceptions


Syntax show threat-prevention exception position <position> position <position>

Parameters

Parameter Description
The order of the rule in comparison to other rules
position
Type: Decimal number

Example show threat-prevention exception position 2 position 2

Output Failure shows an appropriate error message.

show threat-prevention exceptions

Description Malware exceptions

Syntax show threat-prevention exceptions position <position>

Command Line Interface Reference Guide R77.20 Embedded | 252


Parameters

Parameter Description
The order of the rule in comparison to other rules
position
Type: Decimal number

Example show threat-prevention exceptions position 2

Output Failure shows an appropriate error message.

show threat-prevention infected-hosts

Description Infected host

Syntax show threat-prevention infected-hosts

Parameters There are no parameters

Example show threat-prevention infected-hosts

Output Failure shows an appropriate error message.

show threat-prevention ips custom-default-policy

Description Configure the custom default policy if chosen as custom

Syntax show threat-prevention ips custom-default-policy

Parameters There are no parameters


Example show threat-prevention ips custom-default-policy

Output Failure shows an appropriate error message.

show threat-prevention ips network-exception

Description Configure exception rules to bypass IPS protections for specific traffic

Syntax show threat-prevention ips network-exception position <position> position


<position>

Parameters

Parameter Description
The order of the rule in the rule base
position
Type: Decimal number

Example show threat-prevention ips network-exception position 2 position 2

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 253


show threat-prevention ips network-exceptions

Description Configure exception rules to bypass IPS protections for specific traffic

Syntax show threat-prevention ips network-exceptions position <position>

Parameters

Parameter Description
The order of the rule in the rule base
position
Type: Decimal number

Example show threat-prevention ips network-exceptions position 2

Output Failure shows an appropriate error message.

show threat-prevention ips policy

Description Threat Prevention IPS global policy


Syntax show threat-prevention ips policy

Parameters There are no parameters

Example show threat-prevention ips policy

Output Failure shows an appropriate error message.

show threat-prevention ips protection-action-override

IPS topic view

show threat-prevention ips protection-action-override


Description IPS topic view

Syntax show threat-prevention ips protection-action-override protection-code


<protection-code>

Parameters

Parameter Description
The IPS topic the override belongs to. Every override belongs to a single topic
protection-code Type: A number with no fractional part. Values are between -
4,503,599,627,370,495 to 4,503,599,627,370,495

Example show threat-prevention ips protection-action-override protection-code


-1000000

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 254


show threat-prevention ips protection-action-override
Description IPS topic view

Syntax show threat-prevention ips protection-action-override protection-name


<protection-name>

Parameters

Parameter Description
The name of the IPS topic
protection-name
Type: A string of alphanumeric characters without space between them

Example show threat-prevention ips protection-action-override protection-name word


Output Failure shows an appropriate error message.

show threat-prevention policy

Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot

show threat-prevention policy


Description Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot
Syntax show threat-prevention policy
Parameters There are no parameters
Example show threat-prevention policy
Output Failure shows an appropriate error message.

show threat-prevention policy


Description Policy for Threat Prevention, shared by Anti-Virus and Anti-Bot
Syntax show threat-prevention policy advanced-settings
Parameters There are no parameters
Example show threat-prevention policy advanced-settings
Output Failure shows an appropriate error message.

show threat-prevention whitelist files

Description Threat prevention whitelist file


Syntax show threat-prevention whitelist files
Parameters There are no parameters
Example show threat-prevention whitelist files
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 255


show threat-prevention whitelist urls

Description Threat Prevention whitelist URL

Syntax show threat-prevention whitelist urls

Parameters There are no parameters

Example show threat-prevention whitelist urls

Output Failure shows an appropriate error message.

show threat-prevention-advanced

Description Advanced settings for Threat Prevention

Syntax show threat-prevention-advanced advanced-settings

Parameters There are no parameters

Example show threat-prevention-advanced advanced-settings

Output Failure shows an appropriate error message.

show ui-settings

Web Interface Settings and Customizations

show ui-settings
Description Web Interface Settings and Customizations
Syntax show ui-settings

Parameters There are no parameters

Example show ui-settings

Output Failure shows an appropriate error message.

show ui-settings
Description Web Interface Settings and Customizations

Syntax show ui-settings advanced-settings

Parameters There are no parameters

Example show ui-settings advanced-settings

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 256


show usb-modem-watchdog

Description Uses the internet probing (if probing is enabled) to automatically detect and fix 3G/4G internet con-
nectivity problems

Syntax show usb-modem-watchdog advanced-settings

Parameters There are no parameters

Example show usb-modem-watchdog advanced-settings

Output Failure shows an appropriate error message.

show user-awareness

User awareness configuration table

show user-awareness
Description User awareness configuration table

Syntax show user-awareness

Parameters There are no parameters

Example show user-awareness

Output Failure shows an appropriate error message.

show user-awareness
Description User awareness configuration table

Syntax show user-awareness advanced-settings

Parameters There are no parameters

Example show user-awareness advanced-settings

Output Failure shows an appropriate error message.

show user-awareness browser-based-authentication

Description User awareness configuration table

Syntax show user-awareness browser-based-authentication

Parameters There are no parameters

Example show user-awareness browser-based-authentication

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 257


show vpn

Configure remote VPN sites

show vpn
Description Configure remote VPN sites

Syntax show vpn site <site>

Parameters

Parameter Description
Site name
site Type: A string that begins with a letter and contains up to 32 alphanumeric (0-9,
a-z, _ -) characters without spaces

Example show vpn site site17

Output Failure shows an appropriate error message.

show vpn
Description Local network

Syntax show vpn tunnel <tunnel>

Parameters

Parameter Description
A number identifying the Virtual Tunnel Interface (VTI)
tunnel
Type: A number with no fractional part (integer)

Example show vpn tunnel -1000000

Output Failure shows an appropriate error message.

show vpn remote-access

VPN Remote Access

show vpn remote-access


Description VPN Remote Access

Syntax show vpn remote-access

Parameters There are no parameters

Example show vpn remote-access

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 258


show vpn remote-access
Description VPN Remote Access

Syntax show vpn remote-access advanced-settings

Parameters There are no parameters

Example show vpn remote-access advanced-settings

Output Failure shows an appropriate error message.

show vpn remote-access advanced

Description VPN Remote Access

Syntax show vpn remote-access advanced

Parameters There are no parameters

Example show vpn remote-access advanced

Output Failure shows an appropriate error message.

show vpn site-to-site

VPN Global

show vpn site-to-site


Description VPN Global

Syntax show vpn site-to-site

Parameters There are no parameters

Example show vpn site-to-site


Output Failure shows an appropriate error message.

show vpn site-to-site


Description VPN Global

Syntax show vpn site-to-site advanced-settings

Parameters There are no parameters


Example show vpn site-to-site advanced-settings

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 259


show vpn sites

Description Configure remote VPN sites

Syntax show vpn sites

Parameters There are no parameters

Example show vpn sites

Output Failure shows an appropriate error message.

show vpn tunnels

Description Local network

Syntax show vpn tunnels

Parameters There are no parameters

Example show vpn tunnels

Output Failure shows an appropriate error message.

show wlan

Virtual Access Point

show wlan
Description Virtual Access Point
Syntax show wlan vap <vap>

Parameters

Parameter Description
The name of the Virtual Access Point
vap
Type: A string that contains [A-Z], [0-9], ’_’, ’.’, ’-’ and ’/’ characters

Example show wlan vap My_Network


Output Failure shows an appropriate error message.

show wlan
Description Virtual Access Point
Syntax show wlan
Parameters There are no parameters
Example show wlan

Command Line Interface Reference Guide R77.20 Embedded | 260


Output Failure shows an appropriate error message.

show wlan radio

Wireless networks

show wlan radio


Description Wireless networks
Syntax show wlan radio
Parameters There are no parameters
Example show wlan radio
Output Failure shows an appropriate error message.

show wlan radio


Description Wireless networks
Syntax show wlan radio advanced-settings
Parameters There are no parameters
Example show wlan radio advanced-settings
Output Failure shows an appropriate error message.

show wlan statistics

Description Wireless statistics


Syntax show wlan statistics
Parameters There are no parameters
Example show wlan statistics
Output Failure shows an appropriate error message.

show wlan vaps

Description Virtual Access Point


Syntax show wlan vaps
Parameters There are no parameters
Example show wlan vaps
Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 261


show wlan vaps statistics

Description Wireless statistics per vap

Syntax show wlan vaps statistics

Parameters There are no parameters

Example show wlan vaps statistics

Output Failure shows an appropriate error message.

update security-blades

Description Blade update status

Syntax update security-blades [ all ]

Parameters There are no parameters

Example update security-blades all

Output Failure shows an appropriate error message.

Command Line Interface Reference Guide R77.20 Embedded | 262

Вам также может понравиться