Name: ProxySG

Text: Blue Coat ProxySG Command Line Interface Reference

Contact Information
Blue Coat Systems Inc.
420 North Mary Ave
Sunnyvale, CA 94085-4121
http://www.bluecoat.com/support/index.html
bcs.info@bluecoat.com
support@bluecoat.com
http://www.bluecoat.com
For concerns or feedback about the documentation: documentation@bluecoat.com
Copyright© 1999-2006 Blue Coat Systems, Inc. All rights reserved worldwide. No part of this document may be reproduced by any
means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or
other means without the written consent of Blue Coat Systems, Inc. All right, title and interest in and to the Software and documentation
are and shall remain the exclusive property of Blue Coat Systems, Inc. and its licensors. ProxySG™, ProxyAV™, CacheOS™, SGOS™,
Spyware Interceptor™, Scope™ are trademarks of Blue Coat Systems, Inc. and CacheFlow®, Blue Coat®, Accelerating The Internet®,
WinProxy®, AccessNow®, Ositis®, Powering Internet Management®, and The Ultimate Internet Sharing Solution® are registered
trademarks of Blue Coat Systems, Inc. All other trademarks contained in this document and in the Software are the property of their
respective owners.
BLUE COAT SYSTEMS, INC. DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED,
STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT
LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL BLUE COAT SYSTEMS, INC., ITS SUPPLIERS OR ITS LICENSORS BE LIABLE FOR
ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF BLUE COAT SYSTEMS,
INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Document Number: 231-02680
Document Revision: 3.2.7—2/15/06

ii

Contents
Contact Information
Chapter 1: Introduction
Audience for this Document..............................................................................................................................7
Organization of this Document .........................................................................................................................7
Related Blue Coat Documentation....................................................................................................................7
Document Conventions......................................................................................................................................8
SSH and Script Considerations .........................................................................................................................8
Standard and Privileged Modes........................................................................................................................8
Accessing Quick Command Line Help ............................................................................................................9
Chapter 2: Standard and Privileged Mode Commands
Standard Mode Commands.............................................................................................................................11
> display ......................................................................................................................................................................... 11
> enable .......................................................................................................................................................................... 12
> exit................................................................................................................................................................................ 12
> help .............................................................................................................................................................................. 12
> ping.............................................................................................................................................................................. 13
> show ............................................................................................................................................................................ 13
> traceroute .................................................................................................................................................................... 21

Privileged Mode Commands...........................................................................................................................22
# acquire-utc................................................................................................................................................................... 22
# bridge........................................................................................................................................................................... 23
# cancel-upload.............................................................................................................................................................. 23
# clear-arp....................................................................................................................................................................... 23
# clear-cache................................................................................................................................................................... 24
# clear-statistics.............................................................................................................................................................. 24
# configure...................................................................................................................................................................... 25
# disable.......................................................................................................................................................................... 25
# disk............................................................................................................................................................................... 25
# display ......................................................................................................................................................................... 26
# exit ................................................................................................................................................................................ 26
# help............................................................................................................................................................................... 27
# hide-advanced ............................................................................................................................................................ 27
# inline ............................................................................................................................................................................ 27
# kill................................................................................................................................................................................. 31
# licensing....................................................................................................................................................................... 31
# load............................................................................................................................................................................... 31
# pcap.............................................................................................................................................................................. 34
# ping .............................................................................................................................................................................. 37
# policy............................................................................................................................................................................ 37
# purge-dns-cache ......................................................................................................................................................... 37
# restart ........................................................................................................................................................................... 38
# restore-cacheos4-config............................................................................................................................................. 38
# restore-sgos2-config................................................................................................................................................... 39
# restore-defaults........................................................................................................................................................... 39
# reveal-advanced ......................................................................................................................................................... 40
# show............................................................................................................................................................................. 40

Blue Coat ProxySG Command Line Interface Reference

# temporary-route..........................................................................................................................................................52
# test.................................................................................................................................................................................52
# traceroute .....................................................................................................................................................................53
# upload ..........................................................................................................................................................................54

Chapter 3: Privileged Mode Configure Commands
#configure........................................................................................................................................................... 57
#(config) accelerated-pac ..............................................................................................................................................59
#(config) access-log........................................................................................................................................................59
#(config) archive-configuration ...................................................................................................................................68
#(config) attack-detection .............................................................................................................................................69
#(config) bandwidth-gain.............................................................................................................................................73
#(config) banner .............................................................................................................................................................73
#(config) bridge..............................................................................................................................................................74
#(config) bypass-list.......................................................................................................................................................77
#(config) caching............................................................................................................................................................78
#(config) clock ................................................................................................................................................................81
#(config) content ............................................................................................................................................................82
#(config) content-filter ..................................................................................................................................................83
#(config) diagnostics ...................................................................................................................................................100
#(config) dns .................................................................................................................................................................103
#(config) dynamic-bypass ..........................................................................................................................................104
#(config) event-log.......................................................................................................................................................106
#(config) exceptions.....................................................................................................................................................109
#(config) exit .................................................................................................................................................................111
#(config) external-services..........................................................................................................................................111
#(config) failover..........................................................................................................................................................118
#(config) forwarding ...................................................................................................................................................120
#(config) ftp ..................................................................................................................................................................128
#(config) health-check .................................................................................................................................................128
#(config) hide-advanced .............................................................................................................................................132
#(config) hostname ......................................................................................................................................................132
#(config) http ................................................................................................................................................................132
#(config) icp ..................................................................................................................................................................136
#(config) identd............................................................................................................................................................137
#(config) im...................................................................................................................................................................137
#(config) inline .............................................................................................................................................................138
#(config) installed-systems.........................................................................................................................................139
#(config) interface ........................................................................................................................................................140
#(config) ip-default-gateway......................................................................................................................................141
#(config) license-key....................................................................................................................................................142
#(config) line-vty..........................................................................................................................................................142
#(config) load................................................................................................................................................................143
#(config) netbios...........................................................................................................................................................143
#(config) no ...................................................................................................................................................................144
#(config) ntp .................................................................................................................................................................145
#(config) policy.............................................................................................................................................................146
#(config) profile............................................................................................................................................................148
#(config) restart ............................................................................................................................................................148
#(config) return-to-sender ..........................................................................................................................................149
#(config) reveal-advanced ..........................................................................................................................................150
#(config) rip ..................................................................................................................................................................150
#(config) security .........................................................................................................................................................151

iv

Contents

#(config) serial-number...............................................................................................................................................175
#(config) services .........................................................................................................................................................175
#(config) shell ...............................................................................................................................................................197
#(config) show..............................................................................................................................................................198
#(config) snmp .............................................................................................................................................................198
#(config) socks-gateways............................................................................................................................................200
#(config) socks-machine-id.........................................................................................................................................203
#(config) socks-proxy ..................................................................................................................................................203
#(config) splash-generator..........................................................................................................................................204
#(config) ssl...................................................................................................................................................................206
#(config) static-routes..................................................................................................................................................211
#(config) streaming......................................................................................................................................................212
#(config) tcp-ip .............................................................................................................................................................218
#(config) tcp-rtt ............................................................................................................................................................219
#(config) tcp-rtt-use .....................................................................................................................................................220
#(config) telnet-management .....................................................................................................................................220
#(config) timezone .......................................................................................................................................................220
#(config) upgrade-path ...............................................................................................................................................221
#(config) virtual-ip.......................................................................................................................................................221
#(config) wccp ..............................................................................................................................................................221

v

Blue Coat ProxySG Command Line Interface Reference

vi

Chapter 1:

Introduction

To configure and manage your Blue Coat™ Systems ProxySG, Blue Coat developed a software suite
that includes an easy-to-use graphical interface called the Management Console and a Command Line
Interface (CLI). The CLI allows you to perform the superset of configuration and management tasks;
the Management Console, a subset.
This reference guide describes each of the commands available in the CLI.

Audience for this Document
This reference guide is written for system administrators and experienced users who are familiar with
network configuration. Blue Coat assumes that you have a functional network topography, that you
and your Blue Coat Sales representative have determined the correct number and placement of the
ProxySG Appliances, and that those appliances have been installed in an equipment rack and at least
minimally configured as outlined in the Blue Coat Installation Guide that accompanied the ProxySG.
Furthermore, Blue Coat assumes that the Blue Coat ProxySG has been configured for reverse proxy
server acceleration, transparent reverse proxy server acceleration, or a variant of either.

Organization of this Document
This document contains the following chapters:

Chapter 1 – Introduction
The organization of this document; conventions used; descriptions of the CLI modes; and instructions
for saving your configuration.

Chapter 2 – Standard and Privileged Mode Commands
All of the standard mode commands, including syntax and examples, in alphabetical order. All of the
privileged mode commands (except for the configure commands, which are described in Chapter 3),
including syntax and examples, in alphabetical order.

Chapter 3 – #Configure Commands
The #configure command is the most used and most elaborate of all of the CLI commands. For better
readability you will notice that in the command reference chapters, each command heading is
preceded with the appropriate prompt, and for the more complicated commands, the parent
command prompt is included as well.

Related Blue Coat Documentation
You can download the following and other Blue Coat documentation in PDF format at
http://www.bluecoat.com.
ProxySG Series Configuration and Management Guide
ProxySG Content Policy Language
7

Blue Coat ProxySG Command Line Interface Reference

ProxySG 400 Series Installation Guide
ProxySG 600 Series Installation Guide
ProxySG 800 Series Installation Guide
Blue Coat 6000 and 7000 Installation Guide
ProxySG 8000 Series Installation Guide

Document Conventions
The following table lists the typographical and CLI syntax conventions used in this manual.
Convention

Definition

Italics

The first use of a new or Blue Coat-proprietary term.

Courier font

Command-line text that will appear on your administrator workstation.

Courier Italics

A command-line variable that should be substituted with a literal name or
value pertaining to the appropriate facet of your network system.

Courier Boldface

A CLI literal that should be entered as shown.

{}

One of the parameters enclosed within the braces must be supplied

[]

An optional parameter or parameters.

|

Either the parameter before or after the pipe character can or must be
selected, but not both.

SSH and Script Considerations
Consider the following when using the CLI during an SSH session or in a script:
Case Sensitivity. CLI command literals and parameters are not case sensitive.
Command Abbreviations. You may abbreviate CLI commands, provided you supply enough
command characters as to be unambiguous. For example:
SGOS#configure terminal

Can be shortened to:
SGOS#conf t

Note:

You cannot use Telnet until you configure and enable it. (Enabling Telnet introduces a security
risk, so it is not recommended.)

Standard and Privileged Modes
The ProxySG CLI has three major modes—standard, privileged, and configure privileged. In addition,
privileged mode has several subordinate modes. Refer to the introduction in Chapter 2: Standard and
Privileged Mode Commands details about the different modes.

8



Standard mode prompt: >



Privileged mode prompt: #

Chapter 1: Introduction



Configure Privileged mode prompt: #(config)

Accessing Quick Command Line Help
You can access command line help at any time during a session. The following commands are
available in both standard mode and privileged mode.
To access a comprehensive list of mode-specific commands:
Type help or ? at the prompt.
The help command displays how to use CLI help. For example:
SGOS> help
Help may be requested at any point in a command
by typing a question mark '?'.
1. For a list of available commands, enter '?' at
the prompt.
2. For a list of arguments applicable to a command,
precede the '?' with a space (e.g. 'show ?')
3. For help completing a command, do not precede
the '?' with a space (e.g. 'sh?')
The ? command displays the available commands. For example:
SGOS> ?
display
enable
exit
help
ping
show
traceroute

Display a text based url
Turn on privileged commands
Exit command line interface
Information on help
Send echo messages
Show running system information
Trace route to destination

To access a command-specific parameter list:
Type the command name, followed by a space, followed by a question mark.
Note that you must be in the correct mode—standard or privileged—to access the appropriate
help information. For example, to get command completion help for pcap:
SGOS#pcap ?
filter
Setup the current capture filter
info
Display current capture information
.
.
.

To get command completion for configuring SNMP:
SGOS#(config) snmp ?


To access the correct spelling and syntax, given a partial command:
Type the first letter, or more, of the command, followed by a question mark (no spaces).
Note that you must be in the correct mode—standard or privileged—to access the appropriate
help information. For example:

9

Blue Coat ProxySG Command Line Interface Reference

SGOS#p?
pcap
ping

10

purge-dns-cache

Chapter 2:

Standard and Privileged Mode Commands

This chapter describes and provides examples for the Blue Coat ProxySG standard and privileged
mode CLI commands.

Standard Mode Commands
Standard mode is the default mode when you first log on. From standard mode, you can view but you
cannot change configuration settings. In contrast to privileged mode, this mode cannot be
password-protected. Standard mode has a short list of commands.
Note:

For a description of the help command and instructions on using the CLI help, refer to
“Accessing Quick Command Line Help” on page 9.

The standard mode prompt is a greater-than sign; for example:
telnet> open 10.25.36.47
username: admin
password: ******
SGOS>

> display
Use this command to display the source code (such as HTML or Javascript) used to build the named
URL. This source code is displayed one screen at a time. "—More—" at the bottom of the terminal
screen indicates that there is additional code. Press the Spacebar to display the next batch of code;
press the Enter key to display one additional line of code.

Syntax
display url
where url is a valid, fully-qualified text Web address.

Example
SGOS> display http://www.bluecoat.com


Blue Coat Systems, Inc. - Secure Proxy Appliances


.
.
.

> enable
Use this command to enter Privileged mode. Privileged mode commands enable you to view and
change your configuration settings. In some configurations, you must provide a password.
To set username and password, please refer to the instructions provided in the Blue Coat Configuration
and Management Guide.

Syntax
enable

The enable command does not have any parameters or subcommands.
Example
SGOS> enable
Enable Password:******
SGOS# configure terminal
SGOS(config)
.
.
.

See also
disable (disable is a Privileged mode command).

> exit
Use this command to exit the CLI.

Syntax
exit

The exit command does not have any parameters or subcommands.
Example
SGOS> exit

> help
See “Accessing Quick Command Line Help” on page 9 for information about this command.

12

Chapter 2: Standard and Privileged Mode Commands

> ping
Use this command to verify that a particular IP address exists and can accept requests.

Syntax
ping hostname or ip_address
Table 2.1: > ping
hostname

Specifies the name of the host you want to verify.

ip_address

Specifies the IP address you want to verify.

Example
SGOS> ping 10.25.36.47
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 10.25.36.47, timeout is 2 seconds:!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 0/0/0 ms
Number of duplicate packets received = 0

> show
Use this command to display system information.

Syntax
option 1: show accelerated-pac
option 2: show access-log
sub-option 1: [default-logging]
sub-option 2: [format [brief | format_name]]
sub-option 3: [log [brief | log_name]]
sub-option 4: [statistics [log_name]]

option 3: show arp-table
option 4: show bandwidth-gain
option 5: show bridge
sub-option 1: configuration [bridge_name]
sub-option 2: fwtable bridge_name
sub-option 3: statistics bridge_name

option 6: show brief
option 7: show bypass-list
option 8: show caching
option 9: show clock
option 10: show commands
sub-option 1: [delimited [all | privileged]]
sub-option 2: [formatted [all | privileged]]

13

Blue Coat ProxySG Command Line Interface Reference

option 11: show content-distribution
option 12: show cpu
option 13: show diagnostics
sub-option 1: service-info
sub-option 2: status

option 14: show disk
sub-option 1: disk_number
sub-option 2: all

option 15: show dns
option 16: show download-paths
option 17: show dynamic-bypass
option 18: show efficiency
option 19: show environmental
option 20: show event-log [configuration]
option 21: show exceptions
sub-option 1: [built-in_id]
sub-option 2: [user-defined_id]

option 22: show expanded
option 23: show external-services [statistics]
option 24: show failover
sub-option 1: configuration [group_address]
sub-option 2: statistics

option 25: show forwarding
option 26: show health-checks
option 27: show hostname
option 28: show http
option 29: show http-stats
option 30: show icp-settings
option 31: show identd
option 32: show im
sub-option 1: aol-statistics
sub-option 2: configuration
sub-option 3: msn-statistics
sub-option 4: yahoo-statistics

option 33: show installed-systems
option 34: show interface
sub-option 1: all
sub-option 2: interface_number

14

Chapter 2: Standard and Privileged Mode Commands

option 35: show ip-default-gateway
option 36: show ip-route-table
option 37: show ip-rts-table
option 38: show ip-stats
sub-option 1: all
sub-option 2: e# (0 - 7)
sub-option 3: ip
sub-option 4: memory
sub-option 5: summary
sub-option 6: tcp
sub-option 7: udp

option 39: show licenses
option 40: show netbios
option 41: show noprompts
option 42: show ntp
option 43: show policy
sub-option 1: [listing]
sub-option 2: [order]
sub-option 3: [proxy-default]

option 44: show ports
option 45: show profile
option 46: show post-setup
option 47: show resources
option 48: show restart
option 49: show return-to-sender
option 50: show rip
sub-option 1: parameters
sub-option 2: routes
sub-option 3: statistics

option 51: show services
sub-option 1: [aol-im]
sub-option 2: [dns]
sub-option 3: [ftp]
sub-option 4: [http]
sub-option 5: [https]
sub-option 6: [http-console]
sub-option 7: [https-console]
sub-option 8: [mms]

15

Blue Coat ProxySG Command Line Interface Reference

sub-option 9: [msn-im]
sub-option 10: [rtsp]
sub-option 11: [socks]
sub-option 12: [ssh-console]
sub-option 13: [tcp-tunnel]
sub-option 14: [telnet-console]
sub-option 15: [yahoo-im]

option 52: show sessions
option 53: show snmp
option 54: show socks-gateways
option 55: show socks-machine-id
option 56: show socks-proxy
option 57: show sources
sub-option 1: bypass-list
sub-option 2: forwarding
sub-option 3: icp-settings
sub-option 4: license-key
sub-option 5: policy {central | local | forward | vpm-cpl | vpm-xml}
sub-option 6: rip-settings
sub-option 7: socks-gateways
sub-option 8: static-route-table
sub-option 9: wccp-settings

option 58: show ssl
sub-option 1: ccl [list_name]
sub-option 2: ssl-client [ssl_client]

option 59: show static-routes
option 60: show status
option 61: show streaming
sub-option 1: configuration
sub-option 2: quicktime {configuration | statistics}
sub-option 3: real-media {configuration | statistics}
sub-option 4: statistics
sub-option 5: windows-media {configuration | statistics}

option 62: show tcp-rtt
option 63: show telnet-management
option 64: show terminal
option 65: show timezones
option 66: show user-authentication
option 67: show version

16

Chapter 2: Standard and Privileged Mode Commands

option 68: show virtual-ip
option 69: show wccp
sub-option 1: configuration
sub-option 2: statistics
Table 2.2: > show
accelerated-pac
access-log

Displays accelerated PAC file information.
[default-facility |
facility [brief |
facility_name] | format
[brief | format_name] |
statistics
[facility_name]]

Displays the current access log settings.

arp-table

Displays TCP/IP ARP table information.

bandwidth-gain

Displays bandwidth gain status, mode,
and the status of the "substitute get for
get-if-modified-since," "substitute get for
HTTP 1.1 conditional get," and "never
refresh before specified object expiry"
features.

bridge

{configuration
[bridge_name] | fwtable
bridge_name | statistics
bridge_name}

Displays bridge information.

brief

Displays the configuration file without
expanding the inline text files.

bypass-list

Displays the current bypass list.

caching

Displays data regarding cache refresh rates
and settings and caching policies.

clock

Displays the current ProxySG time setting.

commands

[delimited [all |
privileged] | formatted
[all | privileged]]

content-distribution

Displays the available CLI commands.
Delimited displays commands so they can
be parsed, and formatted displays
commands so they can be viewed easily.
Displays the average sizes of objects in the
cache.

cpu

Displays CPU usage.

diagnostics

service-info | status

Displays remote diagnostics information,
including version number, and whether t
the Heartbeats feature and the ProxySG
monitor are currently enabled.

disk

disk_number | all

Displays disk information, including slot
number, vendor, product ID, revision and
serial number, capacity, and status, about
all disks or a specified disk.

dns

Displays primary and alternate DNS
server data.

17

Blue Coat ProxySG Command Line Interface Reference

Table 2.2: > show (Continued)
download-paths

Displays downloaded configuration path
information, including the policy list,
bypass list, accelerated PAC file, HTTP
error page, ICP settings, RIP settings, static
route table, upgrade image, and WCCP
settings.

dynamic-bypass

Displays dynamic bypass configuration
status information.

efficiency

Displays efficiency statistics by objects and
by bytes, as well as information about
non-cacheable objects and access patterns.

environmental

Displays environmental sensor
information.

event-log

[start [YYYY-mm-dd]
[HH:MM:SS]] [end
[YYYY-mm-dd] [HH:MM:SS]]
[regex regex | substring
string]
[configuration]

Show the event-log configuration, using
show event-log configuration, or
show the contents of the event-log, using
the filters offered to narrow the view.

exceptions

[built-in_id] |
[user-defined_id]

Displays exception definitions.

expanded

18

Displays the configuration file, including
the contents of the inline text files.

external-services

[statistics]

Displays external services or external
services statistics information.

failover

configuration
[group_address] |
statistics

Displays failover settings.

forwarding

Displays advanced forwarding settings,
including download-via-forwarding,
health check, and load balancing status,
and the definition of forwarding
hosts/groups and advanced forwarding
rules.

health-checks

Displays health check information.

hostname

Displays the current hostname, IP address,
and type.

http

Displays HTTP configuration information.

http-stats

Displays HTTP statistics, including HTTP
statistics version number, number of
connections accepted by HTTP, number of
persistent connections that were reused,
and the number of active client
connections.

icp-settings

Displays ICP settings.

identd

Displays IDENTD service settings.

Chapter 2: Standard and Privileged Mode Commands

Table 2.2: > show (Continued)
im

aol-statistics |
configuration |
msn-statistics |
yahoo-statistics

installed-systems

interface

Displays IM information.

Displays ProxySG system information
such as version and release numbers, boot
and lock status, and timestamp
information.
all | interface_number

Displays interface status and configuration
information.

ip-default-gateway

Specifies the default IP gateway.

ip-route-table

Displays route table information.

ip-rts-table

Displays return-to-sender route table
information.

ip-stats

all | e# | ip | memory |
summary | tcp | udp

Displays TCP/IP statistics for the current
session.

licenses

Displays produce license information.

netbios

Displays NETBIOS settings.

ntp

Displays NTP servers status and
information.

noprompts

Displays the configuration without using
the --More-- prompt.

policy

[listing | order |
proxy-default]

Displays the current installed policy (no
sub-option), the results of the policy load
(listing), the policy files order (order),
or the policy default of allow or deny
(proxy-default).

ports

Displays HTTP and console port number,
type, and properties.

profile

Displays the system profile.

post-setup

Displays the configuration file without
those elements that are established in
the setup console.

resources

Displays allocation of disk and memory
resources.

restart

Displays system restart settings, including
core image information and compression
status.

return-to-sender

Displays "return to sender" inbound and
outbound settings.

rip

parameters | routes |
statistics

Displays information on RIP settings,
including parameters and configuration,
RIP routes, and RIP statistics.

19

Blue Coat ProxySG Command Line Interface Reference

Table 2.2: > show (Continued)
services

[aol-im | dns | ftp |
http | https |
http-console |
https-console | mms |
msn-im | rtsp | socks |
ssh-console | tcp-tunnel
| telnet-console |
yahoo-im]

sessions

Displays information about the CLI
session.

snmp

Displays SNMP statistics, including status
and MIB variable and trap information.

socks-gateways

Displays SOCKS gateway settings.

socks-machine-id

Displays the id of the secure sockets
machine.

socks-proxy

Displays SOCKS proxy settings.

sources

bypass-list | forwarding
| icp-settings |
license-key | policy
{central | local |
forward | vpm-cpl |
vpm-xml} | rip-settings |
socks-gateways |
static-route-table |
wccp-settings

Displays source listings for installable lists,
such as the bypass-list, license key, policy
files, ICP settings, RIP settings, static route
table, and WCCP settings files.

ssl

ccl [list_name] |
ssl-client [ssl_client]

Displays SSL settings.

static-routes

Displays static route table information.

status

Displays current system status
information, including configuration
information and general status
information.

streaming

20

Displays information about services.

configuration | quicktime
{configuration |
statistics} | real-media
{configuration |
statistics} | statistics
| windows-media
{configuration |
statistics}

Displays QuickTime, RealNetworks, or
Microsoft Windows Media information,
and client and total bandwidth
configurations and usage.

tcp-rtt

Displays default TCP round trip time ticks.

telnet-management

Displays Telnet management status and
the status of SSH configuration through
Telnet.

terminal

Displays terminal configuration
parameters and subcommands.

timezones

Displays timezones used.

Chapter 2: Standard and Privileged Mode Commands

Table 2.2: > show (Continued)
user-authentication

Displays Authenticator Credential Cache
Statistics, including credential cache
information, maximum number of clients
queued for cache entry, and the length of
the longest chain in the hash table.

version

Displays ProxySG hardware and software
version and release information and
backplane PIC status.

virtual-ip
wccp

Displays the current virtual IP addresses.
configuration |
statistics

Displays WCCP configuration and
statistics information.

Examples
SGOS> show caching
Refresh:
Estimated access freshness is 100.0%
Let the ProxySG Appliance manage refresh bandwidth
Current bandwidth used is 0 kilobits/sec
Policies:
Do not cache objects larger than 1024 megabytes
Cache negative responses for 0 minutes
Let the ProxySG Appliance manage freshness
FTP caching:
Caching FTP objects is enabled
FTP objects with last modified date, cached for 10% of last modified time
FTP objects without last modified date, initially cached for 24 hours
SGOS> show resources
Disk resources:
Maximum objects supported:
Cached Objects:
Disk used by system objects:
Disk used by access log:
Total disk installed:
Memory resources:
In use by cache:
In use by system:
In use by network:
Total RAM installed:

1119930
0
537533440
0
18210036736
699203584
83230176
22872608
805306368

> traceroute
Use this command to trace the route from the current host to the specified destination host.

Syntax
traceroute {ip_address | hostname}

21

Blue Coat ProxySG Command Line Interface Reference

Table 2.3: > traceroute
ip_address

Specifies the IP address of the destination host.

hostname

Specifies the name of the destination host.

Example
SGOS> traceroute 10.25.36.47
Type escape sequence to abort.
Tracing the route to 10.25.36.47
1 10.25.36.47 0 0 0

Privileged Mode Commands
Privileged mode provides a robust set of commands that enable you to view, manage, and change
ProxySG settings for features such as log files, authentication, caching, DNS, HTTPS, packet capture
filters, and security.
Note:

The privileged mode subcommand, configure, enables you to manage the ProxySG features.
Refer to Chapter 3: Privileged Mode Configure Commands for detailed information about this
command.

To access privileged mode:
From standard mode, enter privileged mode using the enable command, as shown below:
SGOS> enable
Enable Password:********
SGOS#

If the network administrator who performed the initial network configuration assigned a privileged
mode password, you will be prompted to supply that also. To prevent unauthorized access to your
ProxySG configuration and network, we recommend that you always require a privileged mode
password. The default privileged mode password is admin.
It is important to note that the prompt changes from a greater than sign (>) to a pound sign (#), acting
as an indicator that you are in privileged mode now.
Note:

For a description of the help command and instructions on using the CLI help, refer to
“Accessing Quick Command Line Help” on page 9.

# acquire-utc
Use this command to acquire the Universal Time Coordinates (UTC) from a Network Time Protocol
(NTP) server. To manage objects, a ProxySG must know the current UTC time. Your ProxySG comes
pre-populated with a list of NTP servers available on the Internet, and attempts to connect to them in
the order they appear in the NTP server list on the NTP tab. If the ProxySG cannot access any of the
listed NTP servers, the UTC time must be set manually. For instructions on how to set the UTC time
manually, refer to the Blue Coat Configuration and Management Guide.

22

Chapter 2: Standard and Privileged Mode Commands

Syntax
acquire-utc

The acquire-utc command does not have any parameters or subcommands.
Example
SGOS# acquire-utc
ok

# bridge
This command clears bridge data.

Syntax
bridge
Table 2.4: # bridge
clear-statistics

bridge_name

Clears bridge statistics.

clear-fwtable

bridge_name

Clears bridge forward table.

Example
SGOS# bridge clear-statistics testbridge
ok

# cancel-upload
This command cancels a pending access-log upload. The cancel-upload command allows you to stop
repeated upload attempts if the Web server becomes unreachable while an upload is in progress. This
command sets log uploading back to idle if the log is waiting to retry the upload. If the log is in the
process of uploading, a flag is set to the log. This flag sets the log back to idle if the upload fails.

Syntax
cancel-upload
Table 2.5: # cancel-upload
all
log

Cancels upload for all logs.
log_name

Cancels upload for a specified log.

Example
SGOS# cancel-upload all
ok

# clear-arp
The clear-arp command clears the Address Resolution Protocol (ARP) table. ARP tables are used to
correlate an IP address to a physical machine address recognized only in a local area network. ARP

23

Blue Coat ProxySG Command Line Interface Reference

provides the protocol rules for providing address conversion between a physical machine address
(also known as a Media Access Control or MAC address) and its corresponding IP address, and vice
versa.

Syntax
clear-arp

The clear-arp command does not have any parameters or subcommands.
Example
SGOS# clear-arp
ok

# clear-cache
The clear-cache command sets all objects in the cache to expired. You can clear the system cache at
any time. Although objects are not immediately removed from memory or disk, all subsequent first
requests for objects will be retrieved from the source.

Syntax
clear-cache

Example
SGOS# clear-cache
ok

# clear-statistics
This command clears the Windows Media, Real Media, and QuickTime streaming statistics collected
by the ProxySG. You can also clear the streaming statistics through the Streaming applet. To view
streaming statistics from the Management Console, go to Statistics>Streaming History>Windows
Media/Real Media/Quicktime.

Syntax
clear-statistics
Table 2.6: # clear-statistics
quicktime

Clears the QuickTime statistics.

real-media

Clears the Real Media statistics.

windows-media

Clears the Windows Media statistics.

Example
SGOS# clear-statistics windows-media
ok

24

Chapter 2: Standard and Privileged Mode Commands

# configure
The privileged mode subcommand configure, enables you to manage the ProxySG features. See
Chapter 3: Privileged Mode Configure Commands for detailed information about this command.

# disable
The disable command returns you to Standard mode from Privileged mode.

Syntax
disable

The disable command does not have any parameters or subcommands.
Example
SGOS# disable
SGOS>

See also
enable (Standard mode command)

# disk
Use the disk command to take a disk offline or to reinitialize a disk.
On a multi-disk ProxySG, after issuing the disk reinitialize disk_number command, complete
the reinitialization by setting it to empty and copying pre-boot programs, boot programs and starter
programs, and system images from the master disk to the reinitialized disk. The master disk is the
leftmost valid disk. Valid indicates that the disk is online, has been properly initialized, and is not
marked as invalid or unusable.
Note:

If the current master disk is taken offline, reinitialized or declared invalid or unusable, the
leftmost valid disk that has not been reinitialized since restart becomes the master disk. Thus
as disks are reinitialized in sequence, a point is reached where no disk can be chosen as the
master. At this point, the current master disk is the last disk. If this disk is taken offline,
reinitialized, or declared invalid or unusable, the ProxySG is restarted.

Reinitialization is done without rebooting the ProxySG. The ProxySG operations, in turn, are not
affected, although during the time the disk is being reinitialized, that disk is not available for caching.
Note that only the master disk reinitialization might restart the ProxySG.

Syntax
option 1: disk offline disk_number
option 2: disk reinitialize disk_number

25

Blue Coat ProxySG Command Line Interface Reference

Table 2.7: # disk
offline

disk_number

Takes the disk specified by disk_number
off line.

reinitialize

disk_number

Reinitializes the disk specified by
disk_number.

Example
SGOS# disk offline 3
ok
SGOS# disk reinitialize 3
ok

# display
Use this command to display the source code (such as HTML or Javascript) used to build the named
URL. This source code is displayed one screen at a time. "—More—" at the bottom of the terminal
screen indicates that there is additional code. Press the Spacebar to display the next batch of code;
press the Enter key to display one additional line of code.

Syntax
display url

where url is a valid, fully-qualified text Web address.
Example
SGOS# display www.company1.com


302 Found

Found
The document has moved HREF="http://lc2.law5.company1.passport.com/cgi-bin/log
in">here.




# exit
Exits from Configuration mode to Privileged mode, from Privileged mode to Standard mode. From
Standard mode, the exit command closes the CLI session.

Syntax
exit

The exit command does not have any parameters or subcommands.
Example
SGOS# exit

26

Chapter 2: Standard and Privileged Mode Commands

# help
See “Accessing Quick Command Line Help” on page 9 for information about this command.

# hide-advanced
Use this command to disable advanced commands. See “# reveal-advanced” on page 40 for
information about enabling advanced commands that are disabled.
Note:

You can also use the configure command SGOS#(config) hide-advanced {all | expand}
to hide commands.

Syntax
option 1: hide-advanced all
option 2: hide-advanced expand
Table 2.8: # hide-advanced
all

Hides all advanced commands.

expand

Disables expanded commands.

Example
SGOS# hide-advanced expand
ok
SGOS# hide-advanced all
ok

See also
reveal-advanced

# inline
Installs configuration elements based on your console port input. There are several ways to create a
configuration file for your ProxySG. You can use the inline command or you can create a text file to
contain the configuration commands and settings. You can also create the file locally and browse to it
if you use the Management Console.
If you choose to configure using the inline command, refer to the example below:
SGOS# inline accelerated-pac eof_marker
.
.
.
end
eof_marker

27

Blue Coat ProxySG Command Line Interface Reference

Where eof_marker marks the end of the inline commands.
Note:

You can also use the configure command SGOS#(config) inline accelerated-pac
eof_marker to create a configuration file.

If you choose to create a text file to contain the configuration commands and settings, be sure to assign
the file the extension .txt. Use a text editor to create this file, noting the following ProxySG
configuration file rules:


Only one command (and any associated parameters) permitted, per line



Comments must begin with a semicolon (;)



Comments can begin in any column, however, all characters from the beginning of the comment
to the end of the line are considered part of the comment and, therefore, are ignored

When entering input for the inline command, you can correct mistakes on the current line using the
backspace key. If you detect a mistake in a line that has already been terminated using the Enter key,
you can abort the inline command by typing Ctrl-C. If the mistake is detected after you terminate
input to the inline command, type the same inline command again but with the correct configuration
information. The corrected information replaces the information from the last inline command.
The end-of-input marker is an arbitrary string chosen by the you to mark the end of input for the
current inline command. The string can be composed of standard characters and numbers, but cannot
contain any spaces, punctuation marks, or other symbols.
Take care to choose a unique end-of-input string that does not match any string of characters in the
configuration information.

Syntax
option 1: inline accelerated-pac eof_marker
option 2: inline authentication-form form_name eof_marker
option 3: inline authentication-forms eof_marker
option 4: inline bypass-list
sub-option 1: central eof_marker
sub-option 2: local eof_marker

option 5: inline forwarding eof_marker
option 6: inline icp-settings eof_marker
option 7: inline license-key eof_marker
option 8: inline policy
sub-option 1: central eof_marker
sub-option 2: forward eof_marker
sub-option 3: local eof_marker
sub-option 4: vpm-cpl eof_marker
sub-option 5: vpm-xml eof_marker

option 9: inline rip-settings eof_marker
option 10: inline socks-gateways eof_marker

28

Chapter 2: Standard and Privileged Mode Commands

option 11: inline static-route-table eof_marker
option 12: inline wccp-settings eof_marker
Table 2.9: # inline
accelerated-pac

eof_marker

Updates the accelerated pac file with the
settings you include between the
beginning eof_marker and the ending
eof_marker.

bypass-list

central eof_marker

Updates the central bypass list with the
settings you include between the
beginning eof_marker and the ending
eof_marker.

local eof_marker

Updates the local bypass list with the
settings you include between the
beginning eof_marker and the ending
eof_marker.

forwarding

eof_marker

Updates the forwarding configuration
with the settings you include between the
beginning eof_marker and the ending
eof_marker.

icp-settings

eof_marker

Updates the current ICP settings with the
settings you include between the
beginning eof_marker and the ending
eof_marker.

license-key

eof_marker

Updates the current license key settings
with the settings you include between the
beginning eof_marker and the ending
eof_marker.

29

Blue Coat ProxySG Command Line Interface Reference

Table 2.9: # inline (Continued)
policy

central eof_marker

Updates the current central policy file
with the settings you include between the
beginning eof_marker and the ending
eof_marker.

local eof_marker

Updates the current local policy file with
the settings you include between the
beginning eof_marker and the ending
eof_marker.

forward eof_marker

Updates the current forward policy file
with the settings you include between the
beginning eof_marker and the ending
eof_marker.

vpm-cpl eof_marker

Updates the VPM policy with the settings
you include between the beginning
eof_marker and the ending
eof_marker. (This option is designed to
be used with the Blue Coat Director
product.)

xml-cpl eof_marker

Updates the XML policy with the settings
you include between the beginning
eof_marker and the ending
eof_marker. (This option is designed to
be used with the Blue Coat Director
product.)

rip-settings

eof_marker

Updates the current RIP settings with the
settings you include between the
beginning eof_marker and the ending
eof_marker.

socks-gateway

eof_marker

Updates the current SOCKS gateway
settings with the settings you include
between the beginning eof_marker and
the ending eof_marker.

static-route-table

eof_marker

Updates the current static route table
settings with the settings you include
between the beginning eof_marker and
the ending eof_marker.

wccp-settings

eof_marker

Updates the current WCCP settings with
the settings you include between the
beginning eof_marker and the ending
eof_marker.

Example
SGOS# inline icp-settings eof
icp_port 3130
icp_host 127.0.0.0 sibling 8080 3130
eof

30

Chapter 2: Standard and Privileged Mode Commands

# kill
Terminates a CLI session.

Syntax
kill session_number

where session_number is a valid CLI session number.
Example
SGOS# kill 3
ok

# licensing
Use these commands to request or update licenses.

Syntax
option 1: licensing request-key [user_id] [password]
option 2: licensing update-key
Table 2.10: # licensing
request-key

[user_id] [password]

update-key

Requests the license key from Blue Coat
using the Webpower user ID and
password.
Updates the license key from Blue Coat
now.

Example
SGOS# licensing request-key
User ID: admin
Password: *****
...
ok

where “. . .” represents license download in progress information.

# load
Downloads installable lists or system upgrade images. These installable lists or settings can be
updated using the inline command.
Note:

You can also use the configure command SGOS#(config) load to download installable lists
or system upgrade images.

Syntax
option 1: load accelerated-pac

31

Blue Coat ProxySG Command Line Interface Reference

option 2: load authentication-form form_name
option 3: load authentication-forms
option 4: load bypass-list
sub-option 1: central
sub-option 2: local

option 5: load exceptions
option 6: load forwarding
option 7: load icp-settings
option 8: load license-key
option 9: load policy
sub-option 1: central
sub-option 2: forward
sub-option 3: local
sub-option 4: vpm-cpl
sub-option 5: vpm-software
sub-option 6: vpm-xml

option 10: load rip-settings
option 11: load socks-gateways
option 12: load static-route-table
option 13: load upgrade
option 14: load wccp-settings
Table 2.11: # load
accelerated-pac

32

Downloads the current accelerated pac file
settings.

authentication-form

form_name

Downloads the new authentication form.

bypass-list

central

Downloads the current central bypass list
settings.

local

Downloads the current local bypass list
settings.

exceptions

Downloads new exceptions.

forwarding

Downloads the current forwarding
settings.

icp-settings

Downloads the current ICP settings.

license-key

Downloads the new license key.

Chapter 2: Standard and Privileged Mode Commands

Table 2.11: # load (Continued)
policy

central

Downloads the current central policy file
settings.

forward

Downloads the current forward policy file
settings.

local

Downloads the current local policy file
settings.

vpm-cpl

Downloads a new VPM CPL policy.

vpm-software

Downloads a new VPM version.

vpm-xml

Downloads a new VPM XML policy.

rip-settings

Downloads the current RIP settings.

socks-gateways

Downloads the current SOCKS gateways
settings.

static-route-table

Downloads the current static route table
settings.

upgrade

Downloads the latest system image.

wccp-settings

Downloads the current WCCP settings.

Examples
SGOS# load bypass-list central
Downloading from "www.bluecoat.com/support/subscriptions/CentralBypassList.txt
"
The new policy has been successfully downloaded and installed
SGOS# load policy central
Downloading from "download.bluecoat.com/release/SG3/files/CentralPolicy.txt"
The new policy has been successfully downloaded and installed with 1 warning(s)
Policy installation
Compiling new configuration file: download.bluecoat.com/release/SG3/files/Centra
lPolicy.txt
Tue, 15 Jul 2003 21:40:25 UTC
Warning:
Dynamic bypass is enabled. Sites that are added to the dynamic
bypass is enabled. Sites that are added to the dynamic
There were 0 errors and 1 warning
SGOS# load upgrade
Downloading from "proteus.bluecoat.com/builds/ca_make.19892/wdir/3000.chk"
Downloading new system software (block 2611)
The new system software has been successfully downloaded.
Use "restart upgrade" to install the new system software.

See also
inline

33

Blue Coat ProxySG Command Line Interface Reference

# pcap
This utility enables you to capture packets of Ethernet frames going into or leaving a ProxySG. Packet
capturing allows filtering on various attributes of the frame to limit the amount of data collected. The
collected data can then be transferred to the desktop for analysis.
Note:

Packet capturing increases the amount of processor usage performed in TCP/IP.
Before using the pcap utility, consider that packet capturing doubles the amount of processor
usage performed in TCP/IP.
To capture packets, you must have a tool that can read Packet Sniffer Pro 1.1 files (for
example, EtherReal or Packet Sniffer Pro 3.0).

For an in-depth discussion of PCAP, refer to “Appendix F: Diagnostics” in the Blue Coat Configuration
and Management Guide.

Syntax
option 1: pcap bridge capture-all {enable | disable}
option 2: pcap filter
sub-option 1: [iface {in | out}]
sub-option 2: [iface {in | out} interface_number]
sub-option 3: [iface interface_number]
sub-option 4: [bridge {in | out} name port number]
sub-option 5: [bridge name port number]
sub-option 6: [expr filter_expression]

option 3: pcap info
option 4: pcap coreimage keep n(k)
option 5: pcap start
sub-option 1: [first n]
sub-option 2: [capsize n(k)]
sub-option 3: [trunc n]
sub-option 4: [last n]

option 6: pcap stop
option 7: pcap transfer full_url/filename username password
Table 2.12: # pcap
bridge
capture-all

34

enable | disable

Configures the bridge to capture all packets: disable
captures packets relevant to this device; enable captures all
packets.

Chapter 2: Standard and Privileged Mode Commands

Table 2.12: # pcap (Continued)
filter



No filtering specified (captures all).

[iface {in | out}]

Specifies capture if all specifiers are true either in or out from
the ProxySG.

[iface {in | out}
interface_number]

Specifies capture if all specifiers are true either in or out from
a particular interface (interface number must be between 0
and 16).

[iface
interface_number]

Specifies capture if all specifiers are true both in and out from
a particular interface (interface number must be between 0
and 16).

[bridge {in | out}
bridge_name port
port_number]

Specifies capture if all specifiers are true either in or out on a
particular bridge port.

[bridge bridge_name
port port_number]

Specifies capture if all specifiers are true both in and out on a
particular bridge port.

[expr
filter_expression]

Specifies capture if all specifiers are true for the filter
expression. See Table 2.13 for examples.

coreimage

keep kilobytes

Specifies kilobytes of packets kept in a core image.

start

[first n]

The first n parameter collects n (up to 100 MB) packets.
After the number of packets n is reached, capturing stops.
The packet capture file size is limited to 1% of total RAM,
which might be reached before n packets have been captured.

info

Displays the current packet capture information.

Note: The parameter first n is a specific command; it
captures an exact number of packets. If no parameters are
specified, the default is to capture until the stop
subcommand is issued or the maximum limit reached.
[capsize
n(kilobytes)]

The capsize n(k) parameter stops the collection after n
kilobytes (up to 100 MB) of packets have been captured. The
packet capture file size is limited to 1% of total RAM, which
might be reached before n packets have been captured.
Note: The parameter capsize n is an approximate
command; it captures an approximate number of packets. If
no parameters are specified, the default is to capture until the
stop subcommand is issued or the maximum limit reached.

[trunc n]

The trunc n parameter collects, at most, n bytes of packets
from each frame. This continues until the 1% of total RAM for
file size limitation is reached. Range is 0 to 2147483647.

[last n]

The last n parameter capture saves up to n bytes of packets
in memory. (The maximum amount of memory used for
saving packets is limited to 100 MB.) Any packet received
after the memory limit is reached results in the discarding of
the oldest saved packet prior to saving the new packet. The
saved packets in memory are written to disk when the
capture is terminated. The range is 0 to 2147483647.

full_url/filename
username password

Transfers captured data to an FTP site. Refer to the examples
for details.

stop
transfer

Stops the capture.

35

Blue Coat ProxySG Command Line Interface Reference

Note:

Once a filter is set, it remains in effect until it is redefined, or until the ProxySG is rebooted,
when filtering is set to off; at this point, you must reset or redefine all filtering options.

The following are examples of the pcap parameters/subcommands filter, info, start, and
transfer.
Example 1
Capture transactions among a ProxySG (10.1.1.1), a server (10.2.2.2), and a client (10.1.1.2).
SGOS# pcap filter expr “host 10.1.1.1 || host 10.2.2.2 || host 10.1.1.2”

Example 2
SGOS# pcap filter expr “port 80”
ok
SGOS# pcap start
ok

This captures outbound packets that have a source port of 80 from the interface using the IP
protocol TCP.
SGOS# pcap info
packet capture information:
Packets captured:
381
Bytes captured:
171552
Packets written:
379
Bytes written:
182088
Max packet ram:
0
Packet ram used:
0
Packets filtered:
0
Bridge capture all:
Disabled
Current state:
Capturing
Filtering:
Off
Filter expression:
iface out

This shows relevant information regarding current packet-capturing.
Example 3
The following command stops the capturing of packets after approximately three kilobytes of packets
have been collected.
SGOS# pcap start capsize 3

Example 3
This transfers captured packets to the FTP site 10.25.36.47. Note that the username and password are
provided.
SGOS# pcap transfer ftp://10.25.36.47/path/filename.cap username password

If the folders in the path do not exist, they are not created. An error message is generated.

36

Chapter 2: Standard and Privileged Mode Commands

# ping
Use this command to verify that a particular IP address exists and can accept requests. Ping output
will also tell you the minimum, maximum, and average time it took for the ping test data to reach the
other computer and return to the origin.

Syntax
ping {ip_address | hostname}

where ip_address is the IP address and hostname is the host name of the remote computer.
Example
SGOS# ping 10.25.36.47
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 10.25.36.47, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 0/0/0 ms
Number of duplicate packets received = 0

# policy
Use this command to configure policy commands. Use all to trace all transactions by default, and use
none to specify no tracing except as specified in policy files.
Important: Configuring the policy command to trace all transactions by default can significantly
degrade performance.

Syntax
policy trace {all | none}

Example
SGOS# policy trace all
ok
All requests will be traced by default;
Warning: this can significantly degrade performance.
Use 'policy trace none' to restore normal operation
SGOS# policy trace none
ok

# purge-dns-cache
This command clears the DNS cache. You can purge the DNS cache at any time. You might need to do
so if you have experienced a problem with your DNS server, or if you have changed your DNS
configuration.

Syntax
purge-dns-cache

37

Blue Coat ProxySG Command Line Interface Reference

The purge-dns-cache command does not have any parameters or subcommands.
Example
SGOS# purge-dns-cache
ok

# restart
Restarts the system. The restart options determine whether the ProxySG should simply reboot the
ProxySG (regular), or should reboot using the new image previously downloaded using the load
upgrade command (upgrade).

Syntax
restart {abrupt | regular | upgrade}
Table 2.13: # restart
abrupt

Reboots the system abruptly, according to the version of the ProxySG that is
currently installed.

regular

Reboots the version of the ProxySG that is currently installed.

upgrade

Reboots the entire system image.

Example
SGOS# restart upgrade
ok
SGOS# Read from remote host 10.9.17.159: Connection reset by peer
Connection to 10.9.17.159 closed.

See also
load

# restore-cacheos4-config
Restores the ProxySG to the initial configuration derived upon an upgrade from Cache OS 4.x to
SGOS 2.x. The ProxySG retains the network settings.

Syntax
restore-cacheos4-config

Example
SGOS# restore-cacheos4-config
% "restore-cacheos4-configuration" requires a restart to take effect.
% Use "restart regular" to restart the system.

Or if there is no 4.x configuration found:
SGOS# restore-cacheos4-config
% No CacheOS 4.x configuration is available on this system.

38

Chapter 2: Standard and Privileged Mode Commands

See also
restore-defaults

# restore-sgos2-config
Restores the ProxySG to settings last used with SGOS 2.x. The ProxySG retains the network settings.

Syntax
restore-sgos2-config

Example
SGOS# restore-sgos2-config
% "restore-sgos2-configuration" requires a restart to take effect.
% Use "restart regular" to restart the system.

Or if there is no 2.x configuration found:
SGOS# restore-sgos2-config
%% No SGOS 2.x configuration is available on this system.

See also
restore-defaults

# restore-defaults
Restores the ProxySG to the default configuration. When you restore system defaults, the ProxySG’s IP
address, default gateway, and the DNS server addresses are cleared. In addition, any lists (for
example, forwarding or bypass) are cleared. After restoring system defaults, you need to restore the
ProxySG’s basic network settings, as described in the Blue Coat Configuration and Management Guide,
and reset any customizations.

Syntax
option 1: restore-defaults [factory-defaults]
option 2: restore-defaults [force]
option 3: restore-defaults [keep-console [force]]
Table 2.14: # restore-defaults
[factory-defaults]

Reinitializes the ProxySG to the original settings it had
when it was shipped from the factory.

39

Blue Coat ProxySG Command Line Interface Reference

Table 2.14: # restore-defaults (Continued)
[force]

Restores the system defaults without confirmation.
If you don’t use the force command, you will be
prompted to enter yes or no before the restoration can
proceed.

[keep-console]

[force]

Restores defaults except settings required for console
access. Using the keep-console option retains the
settings for all consoles (Telnet-, SSH-, HTTP-, and
HTTPS-consoles), whether they are enable, disabled, or
deleted.
If you use the force command, you will not be prompted
to enter yes or no before restoration can proceed.

Example
SGOS# restore-defaults
Restoring defaults requires a restart to take effect.
The current configuration will be lost and the system will be restarted.
Continue with restoring? (y/n)[n]: n
Existing configuration preserved.

# reveal-advanced
The reveal-advanced command allows you to enable all or a subset of the advanced commands
available to you when using the CLI. See“# hide-advanced” on page 27 for information about
disabling advanced commands that are enabled.
Note:

You can also use the configure command SGOS#(config) reveal-advanced {all |
expand} to reveal hidden commands.

Syntax
reveal-advanced {all | expand | tcp-ip}
Table 2.15: # reveal-advanced
all

Enables all advanced commands.

expand

Displays expanded commands.

Example
SGOS# reveal-advanced all
ok

# show
Use this command to display system information.
Note:

40

You can also use the configure command SGOS#(config) show to display system
information.

Chapter 2: Standard and Privileged Mode Commands

option 1: show accelerated-pac
option 2: show access-log
sub-option 1: [default-logging]
sub-option 2: [format [brief | format_name]]
sub-option 3: [log [brief | log_name]]
sub-option 4: [statistics [log_name]]

option 3: show archive-configuration
option 4: show arp-table
option 5: show attack-detection
sub-option 1: client [blocked | connections | statistics]
sub-option 2: configuration
sub-option 3: server [statistics]

option 6: show bandwidth-gain
option 7: show bridge
sub-option 1: configuration [bridge_name]
sub-option 2: fwtable bridge_name
sub-option 3: statistics bridge_name

option 8: show bypass-list
option 9: show caching
option 10: show clock
option 11: show commands
sub-option 1: [delimited [all | privileged]]
sub-option 2: [formatted [all | privileged]]

option 12: show configuration
sub-option 1: [brief]
sub-option 2: [expanded]
sub-option 3: [noprompts]

option 13: show content
sub-option 1: outstanding-requests
sub-option 2: priority [regex regex | url url]
sub-option 3: url url

option 14: show content-distribution
option 15: show content-filter
sub-option 1: cerberian
sub-option 2: local
sub-option 3: intersafe
sub-option 4: smartfilter
sub-option 5: surfcontrol
sub-option 6: status

41

Blue Coat ProxySG Command Line Interface Reference

sub-option 7: websense

option 16: show cpu
option 17: show diagnostics
sub-option 1: service-info
sub-option 2: status

option 18: show disk
sub-option 1: disk_number
sub-option 2: all

option 19: show dns
option 20: show download-paths
option 21: show dynamic-bypass
option 22: show efficiency
option 23: show environmental
option 24: show event-log [configuration]
option 25: show exceptions
sub-option 1: [built-in_id]
sub-option 2: [user-defined_id]

option 26: show external-services [statistics]
option 27: show failover
sub-option 1: configuration [group_address]
sub-option 2: statistics

option 28: show forwarding
option 29: show ftp
option 30: show health-checks
option 31: show hostname
option 32: show http
option 33: show http-stats
option 34: show icp-settings
option 35: show identd
option 36: show im
sub-option 1: aol-statistics
sub-option 2: configuration
sub-option 3: msn-statistics
sub-option 4: yahoo-statistics

option 37: show installed-systems
option 38: show interface
sub-option 1: all
sub-option 2: interface_number

42

Chapter 2: Standard and Privileged Mode Commands

option 39: show ip-default-gateway
option 40: show ip-route-table
option 41: show ip-rts-table
option 42: show ip-stats
sub-option 1: all
sub-option 2: e# (0 - 7)
sub-option 3: ip
sub-option 4: memory
sub-option 5: summary
sub-option 6: tcp
sub-option 7: udp

option 43: show licenses
option 44: show netbios
option 45: show ntp
option 46: show policy
sub-option 1: [listing]
sub-option 2: [order]
sub-option 3: [proxy-default]

option 47: show profile
option 48: show realms
option 49: show resources
option 50: show restart
option 51: show return-to-sender
option 52: show rip
sub-option 1: parameters
sub-option 2: routes
sub-option 3: statistics

option 53: show security
option 54: show services
sub-option 1: [aol-im]
sub-option 2: [dns]
sub-option 3: [ftp]
sub-option 4: [http]
sub-option 5: [https]
sub-option 6: [http-console]
sub-option 7: [https-console]
sub-option 8: [mms]
sub-option 9: [msn-im]

43

Blue Coat ProxySG Command Line Interface Reference

sub-option 10: [rtsp]
sub-option 11: [socks]
sub-option 12: [ssh-console]
sub-option 13: [tcp-tunnel]
sub-option 14: [telnet]
sub-option 15: [telnet-console]
sub-option 16: [yahoo-im]

option 55: show sessions
option 56: show shell
option 57: show snmp
option 58: show socks-gateways
option 59: show socks-machine-id
option 60: show socks-proxy
option 61: show sources
sub-option 1: bypass-list
sub-option 2: forwarding
sub-option 3: icp-settings
sub-option 4: license-key
sub-option 5: policy {central | local | forward | vpm-cpl | vpm-xml}
sub-option 6: rip-settings
sub-option 7: socks-gateways
sub-option 8: static-route-table
sub-option 9: wccp-settings

option 62: show splash-generator
option 63: show ssl
sub-option 1: ccl [list_name]
sub-option 2: ssl-client [ssl_client]

option 64: show static-routes
option 65: show status
option 66: show streaming
sub-option 1: configuration
sub-option 2: quicktime {configuration | statistics}
sub-option 3: real-media {configuration | statistics}
sub-option 4: statistics
sub-option 5: windows-media {configuration | statistics}

option 67: show tcp-ip
option 68: show tcp-rtt
option 69: show telnet-management
option 70: show terminal

44

Chapter 2: Standard and Privileged Mode Commands

option 71: show timezones
option 72: show user-authentication
option 73: show version
option 74: show virtual-ip
option 75: show wccp
sub-option 1: configuration
sub-option 2: statistics
Table 2.16: # show
accelerated-pac
access-log

Displays accelerated PAC file
information.
[default-facility |
facility [brief |
facility_name] | format
[brief | format_name] |
statistics
[facility_name]]

arp-table

Displays TCP/IP ARP table information.

archive-configuration
attack-detection

Displays archive configuration settings.
client [blocked |
connections | statistics]

Displays client attack-detection settings.

configuration

Displays attack-detection configuration.

server [statistics]

Displays server attack-detection settings.

bandwidth-gain

bridge

Displays the current access log settings.

Displays bandwidth gain status, mode,
and the status of the "substitute get for
get-if-modified-since," "substitute get for
HTTP 1.1 conditional get," and "never
refresh before specified object expiry"
features.
configuration
[bridge_name] | fwtable
bridge_name | statistics
bridge_name

Displays bridge information.

bypass-list

Displays the current bypass list.

caching

Displays data regarding cache refresh
rates and settings and caching policies.

clock

Displays the current ProxySG time
setting.

commands

[delimited [all |
privileged] | formatted
[all | privileged]]

Displays the available CLI commands.
Delimited displays commands so they can
be parsed, and formatted displays
commands so they can be viewed easily.

configuration

[brief | expanded |
noprompts]

Displays the current configuration, as
different from the default configuration.

45

Blue Coat ProxySG Command Line Interface Reference

Table 2.16: # show (Continued)
content

outstanding-requests |
priority [regex regex |
url url] | url url

content-distribution
content-filter

Displays content management
commands—outstandingrequests displays the complete list of
outstanding asynchronous content
revalidation and distribute requests;
priority displays the deletion priority
value assigned to the regex or url,
respectively; and url displays statistics of
the specified URL.
Displays the average sizes of objects in the
cache.

cerberian | local |
intersafe | smartfilter |
surfcontrol | status |
websense

cpu

Displays the content filter configuration.

Displays CPU usage.

diagnostics

service-info | status

Displays remote diagnostics information,
including version number, and whether
or not the Heartbeats feature and the
ProxySG monitor are currently enabled.

disk

disk_number | all

Displays disk information, including slot
number, vendor, product ID, revision and
serial number, capacity, and status, about
all disks or a specified disk.

dns

Displays primary and alternate DNS
server data.

download-paths

Displays downloaded configuration path
information, including the policy list,
bypass list, accelerated PAC file, HTTP
error page, ICP settings, RIP settings,
static route table, upgrade image, and
WCCP settings.

dynamic-bypass

Displays dynamic bypass configuration
status information.

efficiency

Displays efficiency statistics by objects
and by bytes, as well as information about
non-cacheable objects and access patterns.

environmental

Displays environmental sensor
information.
NOTE: You cannot view environmental
statistics on a ProxySG 400 Series
Appliance.

event-log

46

[start [YYYY-mm-dd]
[HH:MM:SS]] [end
[YYYY-mm-dd] [HH:MM:SS]]
[regex regex | substring
string]
[configuration]

Show the event-log configuration, using
show event-log configuration,
or show the contents of the event-log,
using the filters offered to narrow the
view.

Chapter 2: Standard and Privileged Mode Commands

Table 2.16: # show (Continued)
exceptions

[built-in_id] |
[user-defined_id]

Displays exception definitions.

external-services

[statistics]

Displays external services or external
services statistics information.

failover

configuration
[group_address] |
statistics

Displays failover settings.

forwarding

Displays advanced forwarding settings,
including download-via-forwarding,
health check, and load balancing status,
and the definition of forwarding
hosts/groups and advanced forwarding
rules.

ftp

Displays FTP settings.

health-checks

Displays health check information.

hostname

Displays the current hostname, IP
address, and type.

http

Displays HTTP configuration
information.

http-stats

Displays HTTP statistics, including HTTP
statistics version number, number of
connections accepted by HTTP, number of
persistent connections that were reused,
and the number of active client
connections.

icp-settings

Displays ICP settings.

identd

Displays IDENTD service settings.

im

aol-statistics |
configuration |
msn-statistics |
yahoo-statistics

installed-systems

interface

Displays IM information.

Displays ProxySG system information
such as version and release numbers, boot
and lock status, and timestamp
information.
all | interface_number

Displays interface status and
configuration information, including IP
address, subnet mask, MTU size, source
for instructions, autosense information,
and inbound connection disposition for
the current interface, for all interfaces or
for a specific interface.

ip-default-gateway

Displays default IP gateway IP address,
weight, and group membership.

ip-route-table

Displays route table information.

ip-rts-table

Displays return-to-sender route table
information.

47

Blue Coat ProxySG Command Line Interface Reference

Table 2.16: # show (Continued)
ip-stats

Displays TCP/IP statistics for the current
session.

licenses

Displays produce license information.

netbios

Displays NETBIOS settings.

ntp

Displays NTP servers status and
information.

policy

[listing | order |
proxy-default]

Displays the current installed policy (no
sub-option), the results of the policy load
(listing), the policy files order (order),
or the policy default of allow or deny
(proxy-default).

profile

Displays the system profile.

realms

Displays the security realms.

resources

Displays allocation of disk and memory
resources.

restart

Displays system restart settings, including
core image information and compression
status.

return-to-sender

Displays "return to sender" inbound and
outbound settings.

rip

parameters | routes |
statistics

Displays information on RIP settings,
including parameters and configuration,
RIP routes, and RIP statistics.

services

[aol-im | dns | ftp |
http | https |
http-console |
https-console | mms |
msn-im | rtsp | socks |
ssh-console | tcp-tunnel
| telnet | telnet-console
| yahoo-im]

Displays information about services.

sessions

Displays information about CLI sessions.

snmp

Displays SNMP statistics, including status
and MIB variable and trap information.

socks-gateways

Displays SOCKS gateway settings.

socks-machine-id

Displays the ID of the secure sockets
machine.

socks-proxy

Displays SOCKS proxy settings.

sources

48

all | e# | ip | memory |
summary | tcp | udp

bypass-list | forwarding
| icp-settings |
license-key | policy
{central | local |
forward | vpm-cpl |
vpm-xml} | rip-settings |
socks-gateways |
static-route-table |
wccp-settings

Displays source listings for installable
lists, such as the bypass-list, license key,
policy files, ICP settings, RIP settings,
static route table, and WCCP settings files.

Chapter 2: Standard and Privileged Mode Commands

Table 2.16: # show (Continued)
splash-generator
ssl

Displays general, radius accounting and
TACACS accounting information.
ccl [list_name] |
ssl-client [ssl_client]

Displays SSL settings.

static-routes

Displays static route table information.

status

Displays current system status
information, including configuration
information and general status
information.

streaming

configuration | quicktime
{configuration |
statistics} | real-media
{configuration |
statistics} | statistics
| windows-media
{configuration |
statistics}

Displays QuickTime, RealNetworks, or
Microsoft Windows Media information,
and client and total bandwidth
configurations and usage.

tcp-ip

Displays TCP-IP settings.

tcp-rtt

Displays default TCP round trip time
ticks.

telnet-management

Displays Telnet management status and
the status of SSH configuration through
Telnet.

terminal

Displays terminal configuration
parameters and subcommands.

timezones

Displays timezones used.

user-authentication

Displays Authenticator Credential Cache
Statistics, including credential cache
information, maximum number of clients
queued for cache entry, and the length of
the longest chain in the hash table.

version

Displays ProxySG hardware and software
version and release information and
backplane PIC status.

virtual-ip
wccp

Displays the current virtual IP addresses.
configuration |
statistics

Displays WCCP configuration and
statistics information.

Examples
SGOS# show caching
Refresh:
Estimated access freshness is 100.0%
Let the ProxySG Appliance manage refresh bandwidth
Current bandwidth used is 0 kilobits/sec
Policies:
Do not cache objects larger than 1024 megabytes
Cache negative responses for 0 minutes
Let the ProxySG Appliance manage freshness

49

Blue Coat ProxySG Command Line Interface Reference

FTP caching:
Caching FTP objects is enabled
FTP objects with last modified date, cached for 10% of last modified time
FTP objects without last modified date, initially cached for 24 hours
SGOS# show resources
Disk resources:
Maximum objects supported:
Cached Objects:
Disk used by system objects:
Disk used by access log:
Total disk installed:
Memory resources:
In use by cache:
In use by system:
In use by network:
Total RAM installed:

1119930
0
537533440
0
18210036736
699195392
83238368
22872608
805306368

SGOS# show installed-systems
ProxySG Appliance Systems
1. Version: SGOS 96.99.99.99, Release ID: 20042
Thursday August 21 2003 08:08:58 UTC, Lock Status: Unlocked
Boot Status: Last boot succeeded, Last Successful Boot: Thursday August 21
2003 17:51:50 UTC
2. Version: SGOS 3.0.1.0, Release ID: 20050
Friday August 22 2003 04:43:34 UTC, Lock Status: Unlocked
Boot Status: Last boot succeeded, Last Successful Boot: Monday August 25 2003
21:00:09 UTC
3. Version: SGOS 3.0.1.0, Release ID: 20064
Tuesday August 26 2003 08:23:20 UTC, Lock Status: Unlocked
Boot Status: Last boot succeeded, Last Successful Boot: Tuesday August 26
2003 20:09:51 UTC
4. Version: SGOS 96.99.99.99, Release ID: 20072
Wednesday August 27 2003 08:04:06 UTC, Lock Status: Unlocked
Boot Status: Last boot succeeded, Last Successful Boot: Wednesday August 27
2003 20:10:14 UTC
5. Version: SGOS 96.99.99.99, Release ID: 20030
Friday August 15 2003 08:01:47 UTC, Lock Status: Unlocked
Boot Status: Last boot succeeded, Last Successful Boot: Friday August 15 2003
19:20:32 UTC
Default system to run on next hardware restart: 4
Default replacement being used. (oldest unlocked system)
Current running system: 4
When a new system is loaded, only the system number that was replaced is changed.
The ordering of the rest of the systems remains unchanged.
SGOS# show cpu
Current cpu usage: 0 percent
SGOS# show dns
Primary DNS servers:
216.52.23.101
Alternate DNS servers:
Imputed names:

50

Chapter 2: Standard and Privileged Mode Commands

Resolved names:
Time-to-live: 3600
SGOS# show dynamic-bypass
Dynamic bypass: disabled
Non-HTTP trigger: disabled
HTTP connect error trigger: disabled
HTTP receive error trigger: disabled
HTTP 400 trigger: disabled
HTTP 401 trigger: disabled
HTTP 403 trigger: disabled
HTTP 405 trigger: disabled
HTTP 406 trigger: disabled
HTTP 500 trigger: disabled
HTTP 502 trigger: disabled
HTTP 503 trigger: disabled
HTTP 504 trigger: disabled
SGOS# show hostname
Hostname: 10.25.36.47 - Blue Coat 5000
SGOS# show icp-settings
# Current ICP Configuration
# No update
# ICP Port to listen on (0 to disable ICP)
icp_port 0
# Neighbor timeout (seconds)
neighbor_timeout 2
# ICP and HTTP failure counts
icp_failcount 20
http_failcount 5
# Host failure/recovery notification flags
host_recover_notify on
host_fail_notify on
# 0 neighbors defined, 32 maximum
# ICP host configuration
# icp_host hostname peertype http_port icp_port [options]
#
#
#
#

ICP access: domain configuration
icp_access_domain allow|deny domainname
domainname of 'all' sets default access if no match
0 icp access domains defined, 256 maximum

#
#
#
#

ICP access: IP configuration
icp_access_ip allow|deny ip[/netmask]
ip of '0.0.0.0' sets default access if no match
0 icp access ip's defined, 256 maximum

SGOS# show ntp
NTP is enabled
NTP servers:
ntp.bluecoat.com

51

Blue Coat ProxySG Command Line Interface Reference

ntp2.bluecoat.com
Query NTP server every 60 minutes
SGOS# show snmp
General info:
SNMP is disabled
SNMP writing is disabled
MIB variables:
sysContact:
sysLocation:
Community strings:
Read community:
**********
Write community: **********
Trap community:
**********
Traps:
Trap address 1:
Trap address 2:
Trap address 3:
Authorization traps: disabled

# temporary-route
This command is used to manage temporary route entries.

Syntax
temporary-route {add destination_address netmask gateway_address | delete
destination_address}
Table 2.17: # temporary-route
add

destination_address netmask
gateway_address

Adds a temporary route entry.

delete

destination_address

Deletes a temporary route entry.

# test
This command is used to test subsystems. A test http get command to a particular origin server or
URL, for example, can verify Layer 3 connectivity and also verify upper layer functionality.

Syntax
test http {get url | loopback}
Table 2.18: # test
http

get url

Performs a test Get of an HTTP object
specified by url.

loopback

Performs a loopback test.

Examples
SGOS# test http loopback

52

Chapter 2: Standard and Privileged Mode Commands

Type escape sequence to abort.
Executing HTTP loopback test
Measured throughput rate is 16688.96 Kbytes/sec
HTTP loopback test passed
SGOS# test http get http://www.google.com
Type escape sequence to abort.
Executing HTTP get test
* HTTP request header sent:
GET http://www.google.com/ HTTP/1.0
Host: www.google.com
User-Agent: HTTP_TEST_CLIENT
* HTTP response header recv'd:
HTTP/1.1 200 OK
Connection: close
Date: Tue, 15 Jul 2003 22:42:12 GMT
Cache-control: private
Content-Type: text/html
Server: GWS/2.1
Content-length: 2691
Set-Cookie:
PREF=ID=500ccde1707c20ac:TM=1058308932:LM=1058308932:S=du3WuiW7FC_lJ
Rgn; expires=Sun, 17-Jan-2038 19:14:07 GMT; path=/; domain=.google.com
Measured throughput rate is 66.72 Kbytes/sec
HTTP get test passed

# traceroute
Use this command to trace the route to a destination. The traceroute command can be helpful in
determining where a problem may lie between two points in a network. Use traceroute to trace the
network path from a ProxySG back to a client or to a specific origin Web server. (Note that you can also
use the trace route command from your client station (if supported) to trace the network path between
the client, a ProxySG, and a Web server. Microsoft operating systems generally support the trace route
command from a DOS prompt. The syntax from a Microsoft-based client is: tracert [ip | hostname].)

Syntax
traceroute {IP_address | hostname}
Table 2.19: # traceroute
ip_address

Indicates the IP address of the client or origin server.

hostname

Indicates the host name of the origin server.

Example
SGOS# traceroute 10.25.36.47
Type escape sequence to abort.
Executing HTTP get test
HTTP response code: HTTP/1.0 503 Service Unavailable
Throughput rate is non-deterministic
HTTP get test passed

53

Blue Coat ProxySG Command Line Interface Reference

10.25.36.47# traceroute 10.25.36.47
Type escape sequence to abort.
Tracing the route to 10.25.36.47
1 10.25.36.47 212 0 0 0

# upload
Uploads the current access log or running configuration. Archiving a ProxySG’s system configuration
on a regular basis is a generally prudent measure. In the rare case of a complete system failure,
restoring a ProxySG to its previous state is simplified if you recently uploaded an archived system
configuration to an FTP, HTTP, or HTTPS server. The archive contains all system settings differing
from system defaults, along with any forwarding and security lists installed on the ProxySG. See
Restoring an Archived ProxySG below for instructions.

Syntax
option 1: upload access-log {all | log log_name}
option 2: upload configuration
Table 2.20: # upload
access-log

all

Uploads all access logs to a configured
host.

log log_name

Uploads a specified access log to a
configured host.

configuration

Uploads running configuration to a
configured host.

Example
SGOS# upload configuration
ok

Restoring an Archived ProxySG
Archive and restore operations must be done from the CLI. There is no Management Console Web
interface for archive and restore.
To Restore an Archived System Configuration:
1.

At the command prompt, enter the following command:

SGOS# configure network url

The URL must be in quotation marks, if the filename contains spaces, and must be fully-qualified
(including the protocol, server name or IP address, path, and filename of the archive). The
configuration archive is downloaded from the server, and the ProxySG settings are updated.
If your archived configuration filename does not contain any spaces, quotation marks
surrounding the URL are unnecessary.
2. Enter the following command to restart the ProxySG with the restored settings:
SGOS# restart mode software

54

Chapter 2: Standard and Privileged Mode Commands

Example
SGOS> enable
Enable Password:*****
SGOS# configure network ftp://10.25.36.46/path/10.25.36.47
- Blue Coat 5000 0216214521.config
% Configuring from ftp://10.25.36.46/path/10.25.36.47 - Blue Coat 5000
0216214521.config
.
.
.
ok

55

Blue Coat ProxySG Command Line Interface Reference

56

Chapter 3:

Privileged Mode Configure Commands

#configure
The configure command allows you to configure the Blue Coat Systems ProxySG settings from your
current terminal session (configure terminal), or by loading a text file of configuration settings from
the network (configure network).

Syntax
configure {terminal | network url}
configure_command
configure_command
.
.
.

where configure_command is any of the configuration commands, as shown in Table 3.1. Type a
question mark after each of these commands for a list of subcommands or options with definitions.
Table 3.1: #(config)
accelerated-pac

Configures installation parameters for PAC file.

access-log

Configures the log facilities used in access logging

archive-configuration

Saves system configuration.

attack-detection

Prevents Denial of Services attacks and port scanning.

bandwidth-gain

Configures bandwidth gain.

banner

Defines a login banner.

bridge

Configures bridging.

bypass-list

Configures bypass list settings.

caching

Modifies caching parameters.

clock

Manages the system clock.

content

Adds or deletes objects from the ProxySG.

content-filter

Configures the content filter.

diagnostics

Configures remote diagnostics.

dns

Modifies DNS settings.

dynamic-bypass

Modifies dynamic bypass configuration.

event-log

Configures event log parameters.

exceptions

Configures built-in and user-defined exception response objects.

exit

Returns to the previous prompt.

external-services

Configures external services.

failover

Configures failover.

forwarding

Configures forwarding parameters.

ftp

Configures FTP parameters.

health-check

Configures health check entries.

hide-advanced

Disables commands for advanced subsystems.
57

Blue Coat ProxySG Command Line Interface Reference

Table 3.1: #(config) (Continued)

58

hostname

Sets the system hostname.

http

Configures HTTP parameters.

icp

Configures ICP parameters.

identd

Configures IDENTD parameters.

im

Configures IM parameters.

inline

Installs configurations from console input.

installed-systems

Maintains the list of currently installed ProxySG systems.

interface

Specifies an interface to configure.

ip-default-gateway

Specifies the default IP gateway.

license-key

Configures license key settings.

line-vty

Configures a terminal line.

load

Loads an installable list.

netbios

Configures NETBIOS parameters.

no

Clears certain parameters.

ntp

Modifies NTP parameters.

policy

Specifies CPL rules.

profile

Shows the system profile.

restart

System restart behavior.

return-to-sender

IP “return to sender” behavior.

reveal-advanced

Enables commands for advanced subsystems.

rip

Modifies RIP configuration.

security

Modifies security parameters.

serial-number

Configures serial number.

services

Configures protocol attributes.

shell

Configures options for the Telnet shell.

show

Shows running system information.

snmp

Modifies SNMP parameters.

socks-gateways

Configures upstream SOCKS gateways parameters.

socks-machine-id

Specifies the machine ID for SOCKS.

socks-proxy

Configures SOCKS proxy values.

splash-generator

Configures splash pages.

ssl

Configures SSL parameters.

static-routes

Installation parameters for static routes table.

streaming

Configures streaming parameters.

tcp-rtt

Specifies the default TCP Round Trip Time.

telnet-management

Enables or disables SSHD configuration via Telnet.

timezone

Sets the local timezone.

upgrade-path

Identifies the network path that should be used to download system
software.

virtual-ip

Configures virtual IP addresses.

wccp

Configures WCCP parameters.

Chapter 3: Privileged Mode Configure Commands

Example
SGOS#(config) hide-advanced ?
all
expand
tcp-ip

Hide all advanced commands
Disable expanded commands
Disable commands for TCP-IP

Use the show command to view specific configuration settings or options. Type a space and a question
mark after the show command to see a list of all commands available for this command.
Example
SGOS#(config) show ?
accelerated-pac
access-log
archive-configuration

Accelerated PAC file
Access log settings
Archive configuration settings

SGOS#(config) show accelerated-pac
; Empty Accelerated pac object

#(config) accelerated-pac
Normally, a Web server is kept around to serve the PAC file to client browsers. This feature allows you
to load a PAC file onto the ProxySG for high performance PAC file serving right from the ProxySG.
There are two ways to create an Accelerated PAC file: (1) customize the default PAC file and save it as
a new file, or (2) create a new custom PAC file. In either case, it is important that the client instructions
for configuring ProxySG settings contain the URL of the Accelerated-PAC file. Clients load PAC files
from:
http://your_ProxySG_appliance:8081/accelerated_pac_base.pac.

Syntax
option 1: accelerated-pac no path
option 2: accelerated-pac path url
Table 3.2: #(config) accelerated-pac
no path
path

Clears the network path to download PAC
file.
url

Specifies the location to which the PAC file
should be downloaded.

Example
SGOS#(config) accelerated-pac path 10.25.36.47
ok

#(config) access-log
The ProxySG can maintain an access log for each HTTP request made. The access log can be stored in
one of three formats, which can be read by a variety of reporting utilities. See the Access Log Formats
chapter for additional information on log formats.

59

Blue Coat ProxySG Command Line Interface Reference

Syntax
access-log

This changes the prompt to:
SGOS#(config access-log)

-subcommandsoption 1: create {log log_name | format format_name}
option 2: cancel-upload {all | log log_name}
option 3: default-logging {icp | ftp | http | im | mms | rtsp | socks | tcp-tunnel
| telnet} log_name

option 4: delete {log log_name | format format_name}
option 5: early-upload megabytes
option 6: edit {log log_name—changes the prompt (see “#(config access-log) edit log
log_name” on page 62) | format format_name—changes the prompt (see “#(config access-log)
edit format format_name” on page 67)}
option 7: exit
option 8: max-log-size megabytes
option 9: no default-logging {icp | ftp | http | im | mms | rtsp | socks |
tcp-tunnel}

option 10: overflow-policy {delete | stop}
option 11: upload {all | log log_name}
option 12: view {[log {[brief] | [log_name]}] | [format {[brief] | [format_name]}]
| [statistics [log_name]] | [default-logging]}
Table 3.3: #(config access-log)
create

log log_name

Creates an access log.

format format_name

Creates an access log format.

cancel-upload

all

Cancels upload for all logs.

log log_name

Cancels upload for a log.

default-logging

icp log_name

Chooses a default log for ICP.

ftp log_name

Chooses a default log for FTP.

http log_name

Chooses a default log for HTTP/HTTPS.

im log_name

Chooses a default log for IM.

mms log_name

Chooses a default log for MMS.

rtsp log_name

Chooses a default log for Real
Media/QuickTime.

socks log_name

Chooses a default log for SOCKS.

tcp-tunnel log_name

Chooses a default log for TCP-tunnel.

delete

60

telnet log_name

Chooses a default log for Telnet Proxy.

log log_name

Deletes an access log.

format format_name

Deletes an access log format.

Chapter 3: Privileged Mode Configure Commands

Table 3.3: #(config access-log) (Continued)
early-upload

megabytes

Sets the log size in megabytes that triggers an
early upload.

edit

log log_name

Changes the prompt. See “#(config
access-log) edit log log_name” on
page 62.

format format_name

changes the prompt. See “#(config
access-log) edit format
format_name” on page 67.

exit

Exits configure access-log mode and returns
to configure mode.

max-log-size

megabytes

Sets the maximum size in megabytes that logs
can reach.

no default-logging

icp

Deletes the default log for ICP.

ftp

Deletes the default log for FTP.

http

Deletes the default log for HTTP/HTTPS.

im

Deletes the default log for IM.

mms

Deletes the default log for MMS.

rtsp

Deletes the default log for Real
Media/QuickTime.

socks

Deletes the default log for SOCKS.

tcp-tunnel

Deletes the default log for TCP-tunnel.

delete

Deletes the oldest log entries (up to the entire
log).

stop

Stops access logging until logs are uploaded.

all

Uploads all logs.

log log_name

Uploads a log.

[log {[brief] |
[log_name]}]

Shows the entire access log configuration, a
brief version of the access log configuration,
or the configuration for a specific access log.

[format {[brief] |
[format_name]}]

Shows access log format configuration.

[statistics
[log_name]]

Shows access log statistics.

[default-logging]

Shows the access log default policy.

overflow-policy

upload
view

Example
SGOS#(config) access-log
SGOS#(config access-log) create log test
ok
SGOS#(config access-log) max-log-size 1028
ok
SGOS#(config access-log) overflow-policy delete
ok

View the results. (This is a partial output.)

61

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config access-log) view log
Settings:
Log name: main
Format name: main
Description:
Logs uploaded using FTP client
Logs upload as gzip file
Wait 60 seconds between server connection attempts
FTP client:
Filename format: SG_%f_%l%m%d%H%M%S.log
Filename uses utc time
Use PASV: yes
Use secure connections: no
Primary host site:
Host:
Port: 21
Path:
Username:
Password: ************
Alternate host site:
Host:
Port: 21
Path:

#(config access-log) edit log log_name
Use these commands to edit an access log.

Syntax
access-log

This changes the prompt to:
SGOS#(config access-log)
edit log log_name

This changes the prompt to:
SGOS#(config log log_name)

-subcommandsoption 1: bandwidth kbps
option 2: client-type
sub-option 1: custom
sub-option 2: ftp
sub-option 3: http
sub-option 4: websense

option 3: commands
sub-option 1: cancel-upload
sub-option 2: close-connection

62

Chapter 3: Privileged Mode Configure Commands

sub-option 3: delete-logs
sub-option 4: open-connection
sub-option 5: rotate-remote-log
sub-option 6: send-keep-alive
sub-option 7: test-upload
sub-option 8: upload-now

option 4: connect-wait-time seconds
option 5: continuous-upload
sub-option 1: enable
sub-option 2: keep-alive seconds
sub-option 3: lag-time seconds
sub-option 4: rotate-remote {daily rotation_hour (0-23) | hourly hours [minutes]}

option 6: custom-client
sub-option 1: alternate hostname [port]
sub-option 2: primary hostname [port]
sub-option 3: secure {no | yes}

option 7: description description
option 8: early-upload megabytes
option 9: encryption certificate certificate_name
option 10: exit
option 11: format-name format_name
option 12: ftp-client
sub-option 1: alternate {encrypted-password encrypted_password | host hostname
[port] | password password | path path | username username}
sub-option 2: filename format
sub-option 3: no {alternate | filename | primary}
sub-option 4: pasv {no | yes}
sub-option 5: primary {encrypted-password encrypted_password | host hostname
[port] | password password | path path | username username}
sub-option 6: secure {no | yes}
sub-option 7: time-format {local | utc}

option 13: http-client
sub-option 1: alternate {encrypted-password encrypted_password | host hostname
[port] | password password | path path | username username}
sub-option 2: filename format
sub-option 3: no {alternate | filename | primary}
sub-option 4: primary {encrypted-password encrypted_password | host hostname
[port] | password password | path path | username username}
sub-option 5: secure {no | yes}
sub-option 6: time-format {local | utc}

63

Blue Coat ProxySG Command Line Interface Reference

option 14: no encryption
option 15: periodic-upload
sub-option 1: enable
sub-option 2: upload-interval {daily upload_hour (0-23) | hourly hours [minutes]}

option 16: remote-size megabytes
option 17: upload-type {gzip | text}
option 18: view
option 19: websense-client
sub-option 1: alternate hostname [port]
sub-option 2: primary hostname [port]
Table 3.4: #(config access-log log log_name)
bandwidth

kbps

Sets maximum bandwidth in kbps for log
uploading.

client-type

custom

Uploads log using the custom client.

ftp

Uploads log using the FTP client.

http

Uploads log using the HTTP client.

websense

Uploads log using the Websense LogServer
protocol.

cancel-upload

Cancels a pending access log upload.

close-connection

Closes a manually opened connection to the
remote server.

delete-logs

Permanently deletes all access logs on the
ProxySG.

open-connection

Manually opens a connection to the remote
server.

rotate-remote-log

Switches to a new remote logfile.

send-keep-alive

Sends a keep-alive log packet to the remote
server.

test-upload

Tests the upload configuration by uploading
a verification file.

commands

64

upload-now

Uploads access log now.

connect-wait-time

seconds

Sets time to wait between server connect
attempts.

continuous-upload

enable

Uploads access log continuously to remote
server.

keep-alive seconds

Sets the interval between keep-alive log
packets.

lag-time seconds

Sets the maximum time between log packets
(text upload only).

rotate-remote {daily
rotation_hour (0-23) |
hourly hours
[minutes]}

Specifies when to switch to new remote
logfile.

Chapter 3: Privileged Mode Configure Commands

Table 3.4: #(config access-log log log_name) (Continued)
custom-client

alternate hostname
[port]

Configures the alternate custom server
address.

primary hostname
[port]

Configures the primary custom server
address.

secure {no | yes}

Selects whether to use secure connections
(SSL). The default is no. If yes, the
hostname must match the hostname in the
certificate presented by the server.

description

description

Sets the log description.

early-upload

megabytes

Sets log size in MB which triggers an early
upload.

encryption

certificate
certificate_name

Specifies access-log encryption settings.

exit

Exits configure log log_name mode and
returns to access-log mode.

format-name

format_name

Sets the log format.

ftp-client

alternate
{encrypted-password
encrypted_password |
host hostname [port] |
password password |
path path | username
username}

Configures the alternate FTP host site.

filename format

Configures the remote filename format.

no {alternate |
filename | primary}

Deletes FTP client parameters.

pasv {no | yes}

Sets whether PASV command is sent.

primary
{encrypted-password
encrypted_password |
host hostname [port] |
password password |
path path | username
username}

Configures the primary FTP host site.

secure {no | yes}

Selects whether to use secure connections
(FTPS). The default is no. If yes, the
hostname must match the hostname in the
certificate presented by the server.

time-format {local |
utc}

Selects the time format to use within upload
filename.

65

Blue Coat ProxySG Command Line Interface Reference

Table 3.4: #(config access-log log log_name) (Continued)
http-client

alternate
{encrypted-password
encrypted_password |
host hostname [port] |
password password |
path path | username
username}

Configures the alternate HTTP host site.

filename format

Configures the remote filename format.

no {alternate |
filename | primary}

Deletes HTTP client parameters.

primary
{encrypted-password
encrypted_password |
host hostname [port] |
password password |
path path | username
username}

Configures the primary HTTP host site.

secure {no | yes}

Selects whether to use secure connections
(HTTPS). The default is no. If yes, the
hostname must match the hostname in the
certificate presented by the server.

time-format {local |
utc}

Selects the time format to use within upload
filename.

no

encryption

Disables access-log encryption.

periodic-upload

enable

Uploads access log daily/hourly to remote
server.

upload-interval {daily
upload_hour (0-23) |
hourly hours
[minutes]}

Specifies access log upload interval.

remote-size

megabytes

Sets maximum size in MB of remote log files.

upload-type

{gzip | text}

Sets upload file type (gzip or text).

alternate hostname
[port]

Configures the alternate websense server
address.

primary hostname
[port]

Configures the primary websense server
address.

view
websense-client

Shows log settings.

Example
SGOS#(config) access-log
SGOS#(config access-log) edit log testlog
SGOS#(config log testlog) upload-type gzip
ok
SGOS#(config log testlog) exit
SGOS#(config access-log) exit
SGOS#(config)

66

Chapter 3: Privileged Mode Configure Commands

#(config access-log) edit format format_name
Use these commands to edit an access log format.

Syntax
access-log

This changes the prompt to:
SGOS#(config access-log)
edit format format_name

This changes the prompt to:
SGOS#(config format format_name)

-subcommandsoption 1: exit
option 2: multi-valued-header-policy
sub-option 1: log-all-headers
sub-option 2: log-first-header
sub-option 3: log-last-header

option 3: type
sub-option 1: custom format_string
sub-option 2: elff format_string

option 4: view
Table 3.5: #(config format format_name)
exit
multi-valued-headerpolicy

type
view

Exits configure format format_name mode
and returns to access-log mode.
log-all-headers

Sets multi-valued header policy to log all
headers.

log-first-header

Sets multi-valued header policy to log the
first header.

log-last-header

Sets multi-valued header policy to log the last
header.

custom format_string

Specifies custom logging format.

elff format_string

Specifies W3C extended log file format.
Shows the format settings.

Example
SGOS#(config) access-log
SGOS#(config access-log) edit format testformat
SGOS#(config format testformat) multi-valued-header-policy log-all-headers
ok
SGOS#(config format testformat) exit
SGOS#(config access-log) exit
SGOS#(config)

67

Blue Coat ProxySG Command Line Interface Reference

#(config) archive-configuration
Archiving a ProxySG system configuration on a regular basis is always a good idea. In the rare case of
a complete system failure, restoring a ProxySG to its previous state is simplified by loading an
archived system configuration from an FTP, HTTP, or HTTPS server. The archive contains all system
settings differing from system defaults, along with any forwarding and security lists installed on the
ProxySG.
Archive and restore operations must be done from the CLI. There is no Management Console Web
interface for archive and restore. For details, see “Restoring an Archived ProxySG” on page 54.

Syntax
option 1: archive-configuration encrypted-password encrypted_password
option 2: archive-configuration filename-prefix filename
option 3: archive-configuration host host_name
option 4: archive-configuration password password
option 5: archive-configuration path path
option 6: archive-configuration protocol {ftp | tftp}
option 7: archive-configuration username username
Table 3.6: #(config) archive-configuration
encrypted-password

encrypted_password

Encrypted password for upload host (not
required for TFTP).

filename-prefix

filename

Specifies the prefix that should be applied to
the archive configuration on upload.

host

host_name

Specifies the FTP host to which the archive
configuration should be uploaded.

password

password

Specifies the password for the FTP host to
which the archive configuration should be
uploaded.

path

path

Specifies the path to the FTP host to which the
archive configuration should be uploaded.

protocol

ftp

Indicates the upload protocol to be used for
the archive configuration using FTP.

tftp

Indicates the upload protocol to be used for
the archive configuration using TFTP.

username

Specifies the username for the FTP or FTP
host to which the archive configuration
should be uploaded.

username

Example
SGOS#(config) archive-configuration host host3
ok

68

Chapter 3: Privileged Mode Configure Commands

#(config) attack-detection
The ProxySG can reduce the effects of distributed denial of service (DDoS) attacks and port scanning,
two of the most common virus infections.
The ProxySG prevents attacks by limiting the number of TCP connections from each client IP address
and either will not respond to connection attempts from a client already at this limit or will reset the
connection.

Syntax
attack-detection

This changes the prompt to:
SGOS#(config attack-detection)

-subcommandsoption 1: client—changes the prompt to (config client)
sub-option 1: block ip_address [minutes]
sub-option 2: create ip_address or ip_address_and_length
sub-option 3: default {block-action {drop | send-tcp-rst} | connection-limit
number_of_tcp_connections | failure-limit number_of_requests | unblock-time
minutes | warning-limit number_of_warnings}
sub-option 4: delete ip_address or ip_address_and_length
sub-option 5: disable-limits
sub-option 6: edit ip_address—changes the prompt to (config client ip_address)
{block-action {drop | send-tcp-rst} | connection-limit number_of_tcp_connections |
exit | failure-limit number_of_requests | no {connection-limit | failure-limit |
warning-limit | unblock-time} | unblock-time minutes | view | warning-limit
number_of_warnings}
sub-option 7: enable-limits
sub-option 8: exit
sub-option 9: interval minutes
sub-option 10: no default {connection-limit | failure-limit | warning-limit |
unblock-time}
sub-option 11: view [blocked | connections | statistics]
sub-option 12: unblock ip_address

option 2: exit
option 3: server—changes the prompt to (config server)
sub-option 1: create hostname
sub-option 2: delete hostname
sub-option 3: edit hostname—changes the prompt to (config server hostname) {add
hostname | exit | remove hostname | request-limit number_of_requests | view}
sub-option 4: exit
sub-option 5: view [statistics]

option 4: view

69

Blue Coat ProxySG Command Line Interface Reference

sub-option 1: client [blocked | connections | statistics]
sub-option 2: configuration
sub-option 3: server [statistics]
Table 3.7: #(config attack-detection)
client

Changes the prompt to (config client).
block ip_address [minutes]

Blocks a specific IP address for the number of
minutes listed. If the optional minutes argument is
omitted, the client is blocked until explicitly
unblocked.

create ip_address or
ip_address_and_length

Creates a client with the specified IP address or
subnet.

default block-action {drop |
send-tcp-rst} | connectionlimit integer_between_1_and_
65535 | failure-limit integer_
between_ 1_and_500 | unblocktime minutes_between_10_and_
1440 | warning-limit integer_
between_1_and_100

Default indicates the values that are used if a client

does not have specific limits set. These settings
can over overridden on a per-client basis.
If they are modified on a per-client basis, the
specified limits become the default for new
clients. To change the limits on a per-client
basis, see edit, below.
System defaults for attack-detection limits are:
• block-action: drop
• connection-limit: 100
• failure-limit: 50
• unblock-time: unlimited
• warning-limit: 10

70

delete ip_address or
ip_address_and_length

Deletes the specified client.

disable-limits

Disables attack detection.

edit ip_address

Changes the prompt to (config client
ip_address).
block-action
{drop |
send-tcp-rst}

Indicates the behavior when the client is at the
maximum number of connections: drop connections
that are over the limit or send TCP RST for
connections over the limit. The default is drop.

connectionlimit integer

Indicates the number of simultaneous connections
between 1 and 65535. The default is 100.

exit

Exits the (config client ip_address)
submode and returns to (config client) mode.

failure-limit
integer

Indicates the behavior when the specified client is at
the maximum number of connections: drop
connections that are over the limit or send TCP RST
for connections over the limit. The default is 50.

Chapter 3: Privileged Mode Configure Commands

Table 3.7: #(config attack-detection) (Continued)

exit

no
{connectionlimit |
failure-limit |
unblock-time |
warning-limit}

Clears the specified limits on a per-client basis.

unblock-time
minutes

Indicates the amount of time a client is blocked at the
network level when the client-warning-limit is
exceeded. Time must be a multiple of 10 minutes, up
to a maximum of 1440. The default is unlimited.

view

Displays the limits for this client.

warning-limit
integer

Indicates the number of warnings sent to the client
before the client is blocked at the network level and
the administrator is notified. The default is 10; the
maximum is 100.

If you edit an existing client’s limits to a smaller
value, the new value only applies to new
connections to that client. For example, if the old
value was 10 simultaneous connections and the new
value is 5, existing connections above 5 will not be
dropped.

enable-limits

Enables attack detection. This is a global setting and
cannot be configured individually for specific
clients.

exit

Exits the (config client ip_address) mode
and returns to (config attack-detection)
mode.

interval integer

Indicates the amount of time, in multiples of 10
minutes, that client activity is monitored. The default
is 20. Note that this is a global limit and cannot be
modified for individual clients.

no default {connection-limit |
failure-limit | unblock-time |
warning-limit}

Clears the specified limit settings These settings are
applied to all new clients.

view [blocked | connections |
statistics]

Views all limits for all clients, or you can show
clients blocked at the network level, view the client
connection table, or view client request failure
statistics.

unblock ip_address

Releases a specific IP address.
Exits (config attack-detection) mode and
returns to (config) mode.

71

Blue Coat ProxySG Command Line Interface Reference

Table 3.7: #(config attack-detection) (Continued)
server

view

Changes the prompt to (config server).
create hostname

Creates a server or server group that is identified by
the hostname.

delete hostname

Deletes a server or server group.

edit hostname

Changes the prompt to (config server
hostname).
add hostname

Adds an additional server to this server group.

exit

Exits the (config server hostname) submode
and returns to (config server) mode.

remove
hostname

Removes a server from this group. You cannot
remove the original server from the group.

request-limit
integer

Indicates the number of simultaneous requests
allowed from this server or server group. The default
is 1000.

view

Displays the request limit for this server or server
group.

exit

Exits the (config server hostname) submode
and returns to (config server) mode.

view

Displays the request limit for all servers or server
groups.

client [blocked | connections
| statistics]

Displays client information. The blocked option
displays the clients blocked at the network level, the
connections option displays the client connection
table, and the statistics option displays client
request failure statistics.

configuration

Allows you to view attack-detection configuration
settings or the number of current connections.

server [statistics]

Displays server information. The statistics
option displays server-connection failure statistics.

Example
SGOS#(config) attack-detection
SGOS#(config attack-detection) client
SGOS#(config client) view
Client limits enabled:
true
Client interval:
20 minutes

72

Default client limits:
Client connection limit:
Client failure limit:
Client warning limit:
Blocked client action:
Client connection unblock time:

700
50
10
Drop
unlimited

Client
Client
Client
Client

unlimited
unlimited
unlimited

limits for 10.9.17.159:
connection limit:
failure limit:
warning limit:

Chapter 3: Privileged Mode Configure Commands

Blocked client action:
Client connection unblock time:

Drop
unlimited

Client limits for 10.9.17.134:
Client connection limit:
Client failure limit:
Client warning limit:
Blocked client action:
Client connection unblock time:

700
50
10
Drop
unlimited

#(config) bandwidth-gain
Bandwidth gain is a measure of the effective increase of server bandwidth resulting from the client’s
use of a content accelerator. For example, a bandwidth gain of 100% means that traffic volume from
the ProxySG to its clients is twice as great as the traffic volume being delivered to the ProxySG from
the origin server(s). Using bandwidth gain mode can provide substantial gains in apparent
performance.
Keep in mind that bandwidth gain is a relative measure of the ProxySG’s ability to amplify traffic
volume between an origin server and the clients served by the ProxySG.

Syntax
option 1: bandwidth-gain disable
option 2: bandwidth-gain enable
Table 3.8: #(config) bandwidth-gain
disable

Disables bandwidth-gain mode.

enable

Enables bandwidth-gain mode.

Example
SGOS#(config) bandwidth-gain enable
ok

#(config) banner
This command enables you to define a login banner for your users.

Syntax
option 1: banner login string
option 2: banner no login
Table 3.9: #(config) banner
login
no login

string

Sets the login banner to the value of string.
Sets the login banner to null.

Example
SGOS#(config) banner login “Sales and Marketing Intranet Web”
ok

73

Blue Coat ProxySG Command Line Interface Reference

#(config) bridge
Syntax
bridge

This changes the prompt to:
SGOS#(config bridge)

-subcommandsoption 1: create
option 2: delete
option 3: edit—changes the prompt (see “#(config bridge) edit bridge_name” on page 74)
option 4: exit
Table 3.10: #(config bridge)
create

bridge_name

Creates a bridge.

delete

bridge_name

Deletes a bridge.

edit

bridge_name

Changes the prompt. See “#(config
bridge) edit bridge_name” on page 74.

exit

Example
SGOS#(config) bridge
SGOS#(config bridge) create test
ok
SGOS#(config bridge) exit
SGOS#(config)

#(config bridge) edit bridge_name
Syntax
bridge

This changes the prompt to:
SGOS#(config bridge)
edit bridge_name

This changes the prompt to:
SGOS#(config bridge bridge_name)

-subcommandsoption 1: accept-inbound
option 2: clear-fwtable
option 3: clear-statistics

74

Exits configure bridge mode and returns to
configure mode.

Chapter 3: Privileged Mode Configure Commands

option 4: exit
option 5: failover
option 6: instructions {accelerated-pac | central-pac url | default-pac | proxy}
option 7: ip-address ip_address
option 8: mtu-size mtu_size
option 9: no {accept-inbound | port port_num | failover}
option 10: port port_number
option 11: subnet-mask subnet_mask
option 12: view {configuration | fwtable | statistics}
Table 3.11: #(config bridge bridge_name)
accept-inbound

Allows inbound connections on this interface.

clear-fwtable

Clears bridge forwarding table.

clear-statistics

Clears bridge statistics.

exit

Exits configure bridge bridge_name mode
and returns to configure mode.

failover

failover_group

Associates this bridge to a failover group.

instructions

accelerated-pac

Helps configure browser to use your
accelerated pac file.

central-pac url

Helps configure browser to use your pac file.

default-pac

Helps configure browser to use Blue Coat
Systems pac file.

proxy

Helps configure browser to use a proxy.

ip-address

ip_address

Sets IP address for interface.

mtu-size

mtu_size

Specifies MTU (maximum transmission unit)
size.

no

accept-inbound

Disallows inbound connections on this
interface.

port port#

Negates port settings.

failover

Negates failover settings.

port

port_number

Changes the prompt. See .

subnet-mask

subnet_mask

Sets subnet mask for interface.

view

configuration

Shows bridge configuration.

fwtable

Shows bridge forwarding table.

statistics

Shows bridge statistics.

Example
SGOS#(config) bridge test
SGOS#(config bridge test) accept-inbound
ok
SGOS#(config bridge test) instructions accelerated-pac
ok
SGOS#(config bridge test) exit

75

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config bridge) exit
SGOS#(config)

#(config bridge bridge_name) port_number

Syntax
bridge

This changes the prompt to:
SGOS#(config bridge)
edit bridge_name

This changes the prompt to:
SGOS#(config bridge bridge_name)
port_number

This changes the prompt to:
SGOS#(config bridge bridge_name port_number)

-subcommandsoption 1: attach-interface interface_number
option 2: exit
option 3: full-duplex
option 4: half-duplex
option 5: link-autosense
option 6: speed {10 | 100 | 1gb}
option 7: view
Table 3.12: #(config bridge bridge_name port_number)
attach-interface

interface_number

exit

Exits configure bridge bridge_name
port_number mode and returns to
configure bridge_name mode.

full-duplex

Configures this port for full duplex.

half-duplex

Configures this port for half duplex.

link-autosense

Specifies that this port should autosense
network speed and duplex.

speed

10 | 100 | 1gb

view

Example
SGOS#(config) bridge
SGOS#(config bridge) bridge testname
SGOS#(config bridge testname) port 23

76

Attaches an interface for this port.

Specifies the speed for this port (10 or 100
megabits/second or 1 gigabits/second).
Displays the bridge port settings.

Chapter 3: Privileged Mode Configure Commands

SGOS#(config bridge
ok
SGOS#(config bridge
ok
SGOS#(config bridge
ok
SGOS#(config bridge
SGOS#(config bridge
SGOS#(config)

testname port 23) attach-interface 0
testname port 23) full-duplex
testname port 23) speed 100
testname port 23) exit
testname) exit

#(config) bypass-list
A bypass list prevents the ProxySG from transparently accelerating requests to servers that perform IP
authentication with clients. The bypass list contains IP addresses, subnet masks, and gateways. When
a request matches an IP address and subnet mask specification in the bypass list, the request is sent to
the designated gateway. A bypass list is only used for transparent caching.
There are two types of bypass lists: local and central.
To use bypass routes, create a text file that contains a list of address specifications. The file should be
named with a .txt extension. Once you have created the bypass list, place it on an HTTP server so it
can be installed onto the ProxySG.
You can create your own central bypass list to manage multiple ProxySG Appliances, or you can use
the central bypass list maintained by Blue Coat Systems Technical Support at:
http://www.bluecoat.com/support/subscriptions/CentralBypassList.txt

The central bypass list maintained by Blue Coat Systems contains addresses Blue Coat Systems has
identified as using client authentication.

Syntax
option 1: bypass-list central-path url
option 2: bypass-list local-path url
option 3: bypass-list no {central-path | local-path | notify | subscribe}
option 4: bypass-list notify
option 5: bypass-list poll-now
option 6: bypass-list subscribe
Table 3.13: #(config) bypass-list
central-path

url

Specifies the network path used to download
the central bypass list.

local-path

url

Specifies the network path used to download
the local bypass list.

77

Blue Coat ProxySG Command Line Interface Reference

Table 3.13: #(config) bypass-list (Continued)
no

central-path

Sets the central bypass list path to null.

local-path

Sets the local bypass list path to null.

notify

Instructs the ProxySG to not send an email
notification if the central bypass list changes.

subscribe

Specifies that you do not want to change the
bypass list when changes are made to the
central bypass list.

notify

Instructs the ProxySG to send an email
notification if the central bypass list changes.

poll-now

Checks the central bypass list for changes.

subscribe

Specifies to change the bypass list when
changes are made to the central bypass list.

Example
SGOS#(config) bypass-list local-path 10.25.36.47/files/bypasslist.txt
ok

#(config) caching
When a stored HTTP object expires, it is placed in a refresh list. The ProxySG processes the refresh list
in the background, when it is not serving requests. Refresh policies define how the ProxySG handles
the refresh process.
The HTTP caching options allow you to specify:


Maximum object size



Negative responses



Refresh parameters

In addition to HTTP objects, the ProxySG can store objects requested using FTP. When the ProxySG
retrieves and stores an FTP object, it uses two methods to determine how long the object should stay
cached.


If the object has a last-modified date, the ProxySG assigns a refresh date to the object that is a
percentage of the last-modified date.



If the object does not have a last-modified date, the ProxySG assigns a refresh date to the object
based on a fixed period of time.

Syntax
caching

This changes the prompt to:
SGOS#(config caching)

-subcommandsoption 1: always-verify-source

78

Chapter 3: Privileged Mode Configure Commands

option 2: exit
option 3: ftp—changes the prompt (see “#(config caching) ftp” on page 79)
option 4: max-cache-size megabytes
option 5: negative-response minutes
option 6: no always-verify-source
option 7: refresh {automatic | bandwidth kbps | no automatic}
option 8: view
Table 3.14: #(config caching)
always-verify-source

Specifies the ProxySG to always verify the
freshness of an object with the object source.

ftp

Changes the prompt. See “#(config
caching) ftp” on page 79.

max-cache-size

megabytes

Specifies the maximum size of the cache to
the value indicated by megabytes.

negative-response

minutes

Specifies that negative responses should be
cached for the time period identified by
minutes.

no

always-verify-source

Specifies that the ProxySG should never
verify the freshness of an object with the
object source.

refresh

automatic

Specifies that the ProxySG should manage the
refresh bandwidth.

bandwidth kbps

Specifies the amount of bandwidth in kilobits
to utilize for maintaining object freshness.

no automatic

Specifies that the ProxySG should not manage
the refresh bandwidth.

Example
SGOS#(config) caching
SGOS#(config caching)
ok
SGOS#(config caching)
ok
SGOS#(config caching)
ok
SGOS#(config caching)
ok
SGOS#(config caching)
SGOS#(config)

always-verify-source
max-cache-size 100
negative-response 15
refresh automatic
exit

#(config caching) ftp
The FTP caching options allow you to specify:


Transparency



Maximum object size

79

Blue Coat ProxySG Command Line Interface Reference



Caching objects by date



Caching objects without a last-modified date: if an FTP object is served without a last modified
date, the ProxySG caches the object for a set period of time.

Syntax
caching

This changes the prompt to:
SGOS#(config caching)
ftp

This changes the prompt to:
SGOS#(config caching ftp)

-subcommandsoption 1: disable
option 2: enable
option 3: exit
option 4: type-m-percent percent
option 5: type-n-initial hours
option 6: view
Table 3.15: #(config caching ftp)
disable

Disables caching FTP objects.

enable

Enables caching FTP objects.

exit

Exits configure caching ftp mode and returns
to configure caching mode.

type-m-percent

percent

Specifies the TTL for objects with a
last-modified time.

type-n-initial

hours

Specifies the TTL for objects with no
expiration.

view

Example
SGOS#(config caching) ftp
SGOS#(config caching ftp) enable
ok
SGOS#(config caching ftp) max-cache-size 200
ok
SGOS#(config caching ftp) type-m-percent 20
ok
SGOS#(config caching ftp) type-n-initial 10
ok
SGOS#(config caching ftp) exit
SGOS#(config caching) exit
SGOS#(config)

80

Shows the current FTP caching settings.

Chapter 3: Privileged Mode Configure Commands

#(config) clock
To manage objects in the cache, a ProxySG must know the current Universal Time Coordinates (UTC)
time. By default, the ProxySG attempts to connect to a Network Time Protocol (NTP) server to acquire
the UTC time. The ProxySG includes a list of NTP servers available on the Internet, and attempts to
connect to them in the order they appear in the NTP server list on the NTP tab. If the ProxySG cannot
access any of the listed NTP servers, you must manually set the UTC time using the clock command.

Syntax
option 1: clock day day
option 2: clock hour hour
option 3: clock minute minute
option 4: clock month month
option 5: clock second second
option 6: clock year year
Table 3.16: #(config) clock
day

day

Sets the Universal Time Code (UTC) day to
the day indicated by day. The value can be
any integer from 1 through 31.

hour

hour

Sets the UTC hour to the hour indicated by
hour. The value can be any integer from 0
through 23.

minute

minute

Sets the UTC minute to the minute indicated
by minute. The value can be any integer
from 0 through 59.

month

month

Sets the UTC month to the month indicated
by month. The value can be any integer from
1 through 12.

second

second

Sets the UTC second to the second indicated
by second. The value can be any integer
from 0 through 59.

year

year

Sets the UTC year to the year indicated by
year. The value must take the form xxxx.

Example
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok

clock year 2003
clock month 4
clock day 1
clock hour 0
clock minute 30
clock second 59

81

Blue Coat ProxySG Command Line Interface Reference

#(config) content
Use this command to manage and manipulate content distribution requests and re-validate requests.
Note:

The content command options are not compatible with transparent FTP.

Syntax
option 1: content cancel {outstanding-requests | url url}
option 2: content delete {regex regex | url url}
option 3: content distribute url [from_url]
option 4: content priority {regex priority_0-7 regex | url priority_0-7 url}
option 5: content revalidate {regex regex | url url [from_url]}
Table 3.17: #(config) content
cancel

outstanding-requests

Specifies to cancel all outstanding content
distribution requests and re-validate requests.

url url

Specifies to cancel outstanding content
distribution requests and re-validate requests
for the URL identified by url.

regex regex

Specifies to delete content based on the
regular expression identified by regex.

url url

Specifies to delete content for the URL
identified by url.

distribute

url [from_url]

Specifies that the content associated with url
should be distributed from the origin server.

priority

regex priority_0-7
regex

Specifies to add a content deletion policy
based on the regular expression identified by
regex.

url priority_0-7 url

Specifies to add a content deletion policy for
the URL identified by url.

regex regex

Revalidates the content associated with the
regular expression identified by regex with
the origin server.

url [from_url]

Revalidates the content associated with the
url.

delete

revalidate

Example
SGOS#(config) content distribute http://www.bluecoat.com
Current time: Mon, 01 Apr 2003 00:34:07 GMT
ok
SGOS#(config) content revalidate url http://www.bluecoat.com
Last load time: Mon, 01 Apr 2003 00:34:07 GMT
ok
SGOS#(config) content distribute http://www.bluecoat.com
Current time: Mon, 01 Apr 2003 00:35:01 GMT
ok
SGOS#(config) content priority url 7 http://www.bluecoat.com

82

Chapter 3: Privileged Mode Configure Commands

ok
SGOS#(config) content cancel outstanding-requests
ok
SGOS#(config) content delete url http://www.bluecoat.com
ok

#(config) content-filter
The ProxySG offers the option of using content filtering to control the type of retrieved content and to
filter requests made by clients. The ProxySG supports these content filtering methods:


Local database
This method allows you to produce and maintain your own content-filtering list locally, through
the ProxySG CLI or Management Console.



Vendor-based content filtering
This method allows you to block URLs using vendor-defined categories. For this method, use
content filtering solutions from the following vendors:


SmartFilter™, a provider of Web filtering software used locally on the ProxySG.



Websense®, a provider of Web filtering software, used either locally on the ProxySG and or
remotely on a separate Websense Enterprise Server.



SurfControl™, a provider of Web filtering software used locally on the ProxySG.



Cerberian™, a provider of Web filtering software used locally on the ProxySG.



Proventia™ Web Filter, a provider of Web filtering software used locally on the ProxySG.



InterSafe™, a provider of Web filtering software used locally on the ProxySG.

You can also combine this type of content filtering with the ProxySG policies, which use the Blue
Coat Systems Policy Language.


Denying access to URLs through policy
This method allows you to block by URL, including filtering by scheme, domain, or individual
host or IP address. For this method, you define ProxySG policies, which use the Blue Coat Systems
Policy Language.

Refer to the Content Filtering chapter of the Blue Coat Configuration and Management Guide and the Blue
Coat Content Policy Language Guide for complete descriptions of these features.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)

- subcommandsoption 1: categories

83

Blue Coat ProxySG Command Line Interface Reference

option 2: cerberian—changes the prompt (see “#(config content-filter) bluecoat” on
page 85)

option 3: exit
option 4: intersafe—changes the prompt (see “#(config content-filter) intersafe” on
page 88)

option 5: local—changes the prompt (see “#(config content-filter) local” on page 90)
option 6: no use-local-database | review-message
option 7: select-provider
sub-option 1: cerberian
sub-option 2: intersafe
sub-option 3: none
sub-option 4: proventia
sub-option 5: smartfilter
sub-option 6: surfcontrol
sub-option 7: websense

option 8: proventia—changes the prompt (see “#(config content-filter) proventia” on
page 92)

option 9: review-message
option 10: smartfilter—changes the prompt (see “#(config content-filter) smartfilter”
on page 94)

option 11: surfcontrol—changes the prompt (see “#(config content-filter) surfcontrol”
on page 96)

option 12: test-url url
option 13: use-local-database
option 14: websense—changes the prompt (see “#(config content-filter) websense” on
page 97)

option 15: view
Table 3.18: #(config content-filter)
categories

Shows available categories.

bluecoat

Changes the prompt. See “#(config
content-filter) bluecoat” on page 85.

exit

Exits configure content filter mode and
returns to configure mode.

intersafe

Changes the prompt. See “#(config
content-filter) intersafe” on
page 88.

local

Changes the prompt. See “#(config
content-filter) local” on page 90.

no

84

use-local-database |
review-message

Specifies that a local database not be used for
content filtering, or that vendor
categorization review be turned off.

Chapter 3: Privileged Mode Configure Commands

Table 3.18: #(config content-filter) (Continued)
proventia

Changes the prompt. See “#(config
content-filter) proventia” on
page 92.

review-message

Used for categorization review for certain
Content Filtering vendors. The
review-message setting enables two
substitutions that can be used in exceptions
pages to allow users to review or dispute
content categorization results.

select-provider

cerberian

Selects Cerberian content filtering.

intersafe

Selects InterSafe content filtering.

none

Specifies that a third-party vendor not be
used for content filtering.

proventia

Selects Proventia Web Filter content filtering.

smartfilter

Selects SmartFilter content filtering.

surfcontrol

Selects SurfControl content filtering.

websense

Selects Websense content filtering.

smartfilter

Changes the prompt. See “#(config
content-filter) smartfilter” on
page 94.

surfcontrol

Changes the prompt. See “#(config
content-filter) surfcontrol” on
page 96.

test-url

url

Displays categories for a URL assigned by the
current configuration.

use-local-database

Configures content filtering to use a local
database.

websense

Changes the prompt. See “#(config
content-filter) websense” on page 97.

view

Shows the current settings for the local
database (if it is in use) and the selected
provider (if one is selected).

Example
SGOS#(config) content-filter
SGOS#(config content-filter) select-provider cerberian
loading database....
ok
SGOS#(config content-filter) exit
SGOS#(config)

#(config content-filter) bluecoat
Use this command to configure Blue Coat Web Filter content filtering.

85

Blue Coat ProxySG Command Line Interface Reference

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)
bluecoat

This changes the prompt to:
SGOS#(config bluecoat)

- subcommandsoption 1: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: encrypted-password encrypted_password
sub-option 4: full-get-now
sub-option 5: get-now
sub-option 6: password password
sub-option 7: time-of-day 0-23
sub-option 8: url {default | url}
sub-option 9: username username

option 2: exit
option 3: no download
sub-option 1: auto
sub-option 2: day-of-week {friday | monday | saturday | sunday | thursday |
tuesday | wednesday}
sub-option 3: encrypted-password
sub-option 4: password
sub-option 5: url
sub-option 6: username

option 4: service
sub-option 1: disable
sub-option 2: enable
sub-option 3: mode {background | realtime | none}

option 5: view

86

Chapter 3: Privileged Mode Configure Commands

Table 3.19: #(config bluecoat)
download

auto

Enables automatic database downloads.

day-of-week {all |
friday | monday | none
| saturday | sunday |
thursday | tuesday |
wednesday}

Specifies the day of the week for automatic
downloads.

encrypted-password
encrypted_password

Specifies the encrypted password for the
database download server.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates an immediate database download.

password password

Specifies the password for the database
download server.

time-of-day 0-23

Specifies the time of day for automatic
downloads.

url {default | url}

Specifies using either the default URL or a
specific URL for the database download
server.

username username

Specifies the username for the database
download server.

exit
no download

service

Exits configure bluecoat mode and returns to
configure content-filter mode.
auto

Disables automatic download.

day-of-week {friday |
monday | saturday |
sunday | thursday |
tuesday | wednesday}

Clears day(s) of the week for automatic
download.

encrypted-password

Clears the encrypted password for the
database download server.

password

Clears the password for the database
download server.

url

Clears the URL for the database download
server.

username

Clears the username for the database
download server.

disable | enable

Enables or disables dynamic categorization.

mode {background |
realtime | none}

Configures dynamic categorization to run in
the background, run in real time, or to not
run.

view

Shows the current Blue Coat settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) bluecoat
SGOS#(config bluecoat) service mode background
ok

87

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config bluecoat) exit
SGOS#(config content-filter) exit
SGOS#(config)

#(config content-filter) intersafe
Use this command to configure InterSafe content filtering.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)
intersafe

This changes the prompt to:
SGOS#(config intersafe)

- subcommandsoption 1: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: encrypted-password encrypted_password
sub-option 4: full-get-now
sub-option 5: get-now
sub-option 6: password password
sub-option 7: time-of-day 0-23
sub-option 8: url {default | url}
sub-option 9: username username

option 2: exit
option 3: no download
sub-option 1: auto
sub-option 2: day-of-week {friday | monday | saturday | sunday | thursday | tuesday
| wednesday}
sub-option 3: encrypted-password
sub-option 4: password
sub-option 5: url
sub-option 6: username

option 4: view

88

Chapter 3: Privileged Mode Configure Commands

Table 3.20:
download

#(config intersafe)
auto

Enables automatic database downloads.

day-of-week {all |
friday | monday | none
| saturday | sunday |
thursday | tuesday |
wednesday}

Specifies the day of the week for automatic
downloads.

encrypted-password
encrypted_password

Specifies the encrypted password for the
database download server.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates an immediate database download.

password password

Specifies the password for the database
download server.

time-of-day 0-23

Specifies the time of day for automatic
downloads.

url {default | url}

Specifies using either the default URL or a
specific URL for the database download
server.

username username

Specifies the username for the database
download server.

exit
no download

view

Exits configure intersafe mode and returns to
configure content-filter mode.
auto

Disables automatic download.

day-of-week {friday |
monday | saturday |
sunday | thursday |
tuesday | wednesday}

Clears day(s) of the week for automatic
download.

encrypted-password

Clears the encrypted password for the
database download server.

password

Clears the password for the database
download server.

url

Clears the URL for the database download
server.

username

Clears the username for the database
download server.
Shows the current InterSafe settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) intersafe
SGOS#(config intersafe) no download day-of-week mon
ok
SGOS#(config intersafe) no download day-of-week wed
ok
SGOS#(config intersafe) exit
SGOS#(config content-filter) exit
SGOS#(config)

89

Blue Coat ProxySG Command Line Interface Reference

#(config content-filter) local
Use this command to configure local content filtering.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)
local

This changes the prompt to:
SGOS#(config local)

- subcommandsoption 1: clear
option 2: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: encrypted-password encrypted_password
sub-option 4: full-get-now
sub-option 5: get-now
sub-option 6: password password
sub-option 7: time-of-day 0-23
sub-option 8: url url
sub-option 9: username username

option 3: exit
option 4: no download
sub-option 1: auto
sub-option 2: day-of-week {friday | monday | saturday | sunday | thursday | tuesday
| wednesday}
sub-option 3: encrypted-password
sub-option 4: password
sub-option 5: url
sub-option 6: username

option 5: source
option 6: view
Table 3.21: #(config local)
clear

90

Clears the database from the system.

Chapter 3: Privileged Mode Configure Commands

Table 3.21: #(config local) (Continued)
download

auto

Enables automatic database downloads.

day-of-week {all |
friday | monday | none
| saturday | sunday |
thursday | tuesday |
wednesday}

Specifies the day of the week for automatic
downloads.

encrypted-password
encrypted_password

Specifies the encrypted password for the
database download server.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates an immediate database download. If
the previously downloaded database is
up-to-date, no download is necessary and
none is performed.

password password

Specifies the password for the database
download server.

time-of-day 0-23

Specifies the time of day for automatic
downloads.

url url

Specifies the URL for the database download
server.

username username

Specifies the username for the database
download server.

exit
no download

Exits configure local mode and returns to
configure content-filter mode.
auto

Disables automatic download.

day-of-week {friday |
monday | saturday |
sunday | thursday |
tuesday | wednesday}

Clears day(s) of the week for automatic
download.

encrypted-password

Clears the encrypted password for the
database download server.

password

Clears the password for the database
download server.

url

Clears the URL for the database download
server.

username

Clears the username for the database
download server.

source

Shows the database source file.

view

Shows the current local settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) local
SGOS#(config local) download day-of-week all
ok
SGOS#(config local) exit

91

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config content-filter) exit
SGOS#(config)

#(config content-filter) proventia
Use this command to configure Proventia Web Filter content filtering.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)
proventia

This changes the prompt to:
SGOS#(config proventia)

- subcommandsoption 1: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: encrypted-password encrypted_password
sub-option 4: full-get-now
sub-option 5: get-now
sub-option 6: password password
sub-option 7: time-of-day 0-23
sub-option 8: url {default | url}
sub-option 9: username username

option 2: exit
option 3: no download
sub-option 1: auto
sub-option 2: day-of-week {friday | monday | saturday | sunday | thursday | tuesday
| wednesday}
sub-option 3: encrypted-password
sub-option 4: password
sub-option 5: url
sub-option 6: username

option 4: view

92

Chapter 3: Privileged Mode Configure Commands

Table 3.22:
download

#(config proventia)
auto

Enables automatic database downloads.

day-of-week {all |
friday | monday | none
| saturday | sunday |
thursday | tuesday |
wednesday}

Specifies the day of the week for automatic
downloads.

encrypted-password
encrypted_password

Specifies the encrypted password for the
database download server.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates an immediate database download. If
a full download is unnecessary, an
incremental download will be initiated.

password password

Specifies the password for the database
download server.

time-of-day 0-23

Specifies the time of day for automatic
downloads.

url {default | url}

Specifies using either the default URL or a
specific URL for the database download
server.

username username

Specifies the username for the database
download server.

exit
no download

Exits configure proventia mode and returns
to configure content-filter mode.
auto

Disables automatic download.

day-of-week {friday |
monday | saturday |
sunday | thursday |
tuesday | wednesday}

Clears day(s) of the week for automatic
download.

encrypted-password

Clears the encrypted password for the
database download server.

password

Clears the password for the database
download server.

url

Clears the URL for the database download
server.

username

Clears the username for the database
download server.

view

Shows the current Proventia Web Filter
settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) proventia
SGOS#(config proventia) download time-of-day 20
ok
SGOS#(config proventia) exit

93

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config content-filter) exit
SGOS#(config)

#(config content-filter) smartfilter
Use this command to configure SmartFilter filters that control the type of content retrieved by the
ProxySG and filter requests made by clients.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)
smartfilter

This changes the prompt to:
SGOS#(config smartfilter)

- subcommandsoption 1: allow-rdns
option 2: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: encrypted-password encrypted_password
sub-option 4: full-get-now
sub-option 5: get-now
sub-option 6: password password
sub-option 7: time-of-day 0-23
sub-option 8: url {default | premier-list {ftp | http} | standard-list {ftp | http}
| url}
sub-option 9: username username

option 3: exit
option 4: list-version {3 | 4}
option 5: no
sub-option 1: allow-rdns
sub-option 2: download {auto | day-of-week {friday | monday | saturday | sunday |
thursday | tuesday | wednesday} | encrypted-password | password | url | username}

option 6: view
Table 3.23: #(config smartfilter)
allow-rdns

94

Allow reverse DNS for lookups.

Chapter 3: Privileged Mode Configure Commands

Table 3.23: #(config smartfilter) (Continued)
download

auto

Enables automatic download.

day-of-week {all |
friday | monday | none
| saturday | sunday |
thursday | tuesday |
wednesday}

Sets day(s) of the week for automatic
download.

encrypted-password
encrypted_password

Version 3.x only. Specifies the encrypted
password for the database download server.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates immediate database download. If a
full download is unnecessary, an incremental
download is initiated.

license license_key

Version 4.x only. The customer serial
number assigned you by SmartFilter.

password password

Version 3.x only. Specifies the password for
the database download server.

server
IP_address_or_hostname

Version 4.x only. Enter the IP address or
hostname of the server you should use for
downloads if requested.

time-of-day 0-23

Sets time of day (UTC) for automatic
download.

url {default |
premier-list {ftp |
http} | standard-list
{ftp | http} | url}

Specifies the download URL. You can specify
a URL (url url) or use the default. To use
the default for version 4.x, use the default
command. To use the default for version 3.x,
select the type of control list
(standard-list or premier-list) and
the protocol (ftp or http).

username username

Specifies the username for the database
download server.

exit

Exits configure smartfilter mode and returns
to configure content-filter mode.

list-version

3 | 4

Specifies the version (3.x or 4.x) of the
SmartFilter control list.

no

allow-rdns

Disallows reverse DNS for lookups.

download {auto |
day-of-week {friday |
monday | saturday |
sunday | thursday |
tuesday | wednesday} |
encrypted-password |
password | url |
username}

Negates download commands.

use-search keywords

Disables the ability to categorize search
engines based on keywords in the URL
query.

95

Blue Coat ProxySG Command Line Interface Reference

Table 3.23: #(config smartfilter) (Continued)
use-search-keywords

no

view

Allows you to categorize search engines
based on keywords in the URL query.
Shows the current SmartFilter settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) smartfilter
SGOS#(config smartfilter) allow-rdns
ok
SGOS#(config smartfilter) exit
SGOS#(config content-filter) exit
SGOS#(config)

#(config content-filter) surfcontrol
Use this command to configure SurfControl filters that control the type of content retrieved by the
ProxySG and filter requests made by clients.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)
surfcontrol

This changes the prompt to:
SGOS#(config surfcontrol)

- subcommandsoption 1: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: full-get-now
sub-option 4: get-now
sub-option 5: license license_key
sub-option 6: time-of-day 0-23
sub-option 7: url {default | url}

option 2: exit
option 3: no download {auto | day-of-week {friday | monday | saturday | sunday |
thursday | tuesday | wednesday} | license | url}
option 4: view

96

Chapter 3: Privileged Mode Configure Commands

Table 3.24: #(config surfcontrol)
download

auto

Enables automatic download.

day-of-week {all |
friday | monday | none
| saturday | sunday |
thursday | tuesday |
wednesday}

Sets day(s) of the week for automatic
download.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates an immediate database download. If
the previously downloaded database is
up-to-date, no download is necessary and
none is performed.

license

Sets the download license key.

time-of-day 0-23

Sets time of day (UTC) for automatic
download.

url {default | url}

Specifies the URL from which to download
database.

exit
no download

Exits configure surfcontrol mode and returns
to configure content-filter mode.
auto | day-of-week
{friday | monday |
saturday | sunday |
thursday | tuesday |
wednesday} | license |
url

view

Negates download commands.

Shows the current SurfControl settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) surfcontrol
SGOS#(config surfcontrol) no download url
ok
SGOS#(config surfcontrol) exit
SGOS#(config content-filter) exit
SGOS#(config)

#(config content-filter) websense
Use this command to configure Websense filters that control the type of content retrieved by the
ProxySG and filter requests made by clients.

Syntax
content-filter

This changes the prompt to:
SGOS#(config content-filter)

97

Blue Coat ProxySG Command Line Interface Reference

websense

This changes the prompt to:
SGOS#(config websense)

- subcommandsoption 1: download
sub-option 1: auto
sub-option 2: day-of-week {all | friday | monday | none | saturday | sunday |
thursday | tuesday | wednesday}
sub-option 3: email-contact email_address
sub-option 4: full-get-now
sub-option 5: get-now
sub-option 6: license license_key
sub-option 7: server {ip_address | hostname}
sub-option 8: time-of-day 0-23

option 2: exit
option 3: integration-service
sub-option 1: disable
sub-option 2: enable
sub-option 3: host (hostname or ip_address)
sub-option 4: port {integer between 0 and 65535}

option 4: no
sub-option 1: download {auto | day-of-week {friday | monday | saturday | sunday |
thursday | tuesday | wednesday} | email-contact | license | server}
sub-option 2: integration-service
sub-option 3: use-regexes

option 5: use-regexes
option 6: view

98

Chapter 3: Privileged Mode Configure Commands

Table 3.25: #(config websense)
download

auto

Enables automatic download.

day-of-week

Sets day(s) of the week for automatic
download.

email-contact
email_address

Specifies an email address that is sent to
Websense when downloading the database.

full-get-now

Initiates an immediate full-size database
download.

get-now

Initiates immediate database download. If a
full download is unnecessary, an incremental
download will be initiated.

license license_key

Specifies the license key for the database
download server.

server {ip_address |
hostname}

Specifies the server location of the database.

time-of-day

Sets time of day (UTC) for automatic
download.

exit
integration-service

no

Exits configure websense mode and returns
to configure content-filter mode.
disable

Disables the integration service.

enable

Enables the integration service.

host hostname or
ip_address

Set the integration service hostname or IP
address. The IP address must match the IP
address of the Websense Log Server.

port integer

Configure the integration service port.
Accepted values are between 0 and 65535

download {auto |
day-of-week {friday |
monday | saturday |
sunday | thursday |
tuesday | wednesday} |
email-contact |
license | server}

Clears the download parameters.

use-regexes

No regular expression filters can be used.

integration-service
{host | port)

Clears the integration-service host or port

use-regexes

Regular expression filters can be used.

view

Shows the current SurfControl settings.

Example
SGOS#(config) content-filter
SGOS#(config content-filter) websense
SGOS#(config websense) no use-regexes
ok
SGOS#(config websense) exit
SGOS#(config content-filter) exit
SGOS#(config)

99

Blue Coat ProxySG Command Line Interface Reference

#(config) diagnostics
This command enables you to configure the remote diagnostic feature Heartbeat.

Syntax
diagnostics

This changes the prompt to:
SGOS#(config diagnostics)

- subcommandsoption 1: exit
option 2: heartbeat {disable | enable}
option 3: monitor {disable | enable}
option 4: send-heartbeat
option 5: service-info—changes the prompt (see “#(config diagnostics) service-info” on
page 101)

option 6: snapshot {create | delete | edit} snapshot_name
option 7: view
Table 3.26: #(config diagnostics)
exit

Exits configure diagnostics mode and returns
to configure mode.

heartbeat

disable | enable

Enables or disables the ProxySG Heartbeat
features.

monitor

disable | enable

Enables or disables the monitoring feature.

send-heartbeat

Triggers a heartbeat report.

service-info

Changes the prompt. See “#(config
diagnostics) service-info” on
page 101.

snapshot

create snapshot_name

Creates a new snapshot job.

delete snapshot_name

Deletes a snapshot job.

edit snapshot_name

Changes the prompt. See “#(config
diagnostics) snapshot
snapshot_name” on page 102.

view

Example
SGOS#(config) diagnostics
SGOS#(config diagnostics) heartbeat enable
ok
SGOS#(config diagnostics) exit
SGOS#(config)

100

Displays the current diagnostics settings.

Chapter 3: Privileged Mode Configure Commands

#(config diagnostics) service-info
This command allows you to send service information to Blue Coat Systems.

Syntax
diagnostics

This changes the prompt to:
SGOS#(config diagnostics)
service-info

This changes the prompt to:
SGOS#(diagnostics service-info)

- subcommandsoption 1: auto
sub-option 1: disable
sub-option 2: enable
sub-option 3: no sr-number
sub-option 4: sr-number sr_number

option 2: cancel
sub-option 1: all
sub-option 2: one_or_more_from_view_status

option 3: exit
option 4: send sr_number one_or_more_commands_from_view_available
option 5: view
sub-option 1: available
sub-option 2: status
Table 3.27: #(config diagnostics service-info)
auto

cancel

exit

disable

Disables the automatic service information
feature.

enable

Enables the automatic service information
feature.

no sr-number

Clears the service-request number for the
automatic service information feature.

sr-number sr_number

Sets the service-request number for the
automatic service information feature.

all

Cancel all service information being sent to
Blue Coat Systems.

one_or_more_from_view_
status

Cancel certain service information being sent
to Blue Coat Systems.
Exits configure diagnostics service-info mode
and returns to configure diagnostics mode.

101

Blue Coat ProxySG Command Line Interface Reference

Table 3.27: #(config diagnostics service-info) (Continued)
send

view

sr_num
one_or_more_commands_
from_view_available

Sends a specific service request number along
with a specific command or commands
(chosen from the list provided by the view
available command) to Blue Coat Systems.

one_or_more_commands_
from_view_available

Sends certain commands to Blue Coat
Systems.

available

Shows list of service information than can be
sent to Blue Coat Systems.

status

Shows transfer status of service information
to Blue Coat Systems.

Example
SGOS#(config) diagnostics
SGOS#(config diagnostics) service-info
SGOS#(diagnostics service-info) view available
Service information that can be sent to Blue Coat
Name
Approx Size (bytes)
Event_log
188,416
System_information
Unknown
Snapshot_sysinfo
Unknown
Snapshot_sysinfo_stats
Unknown
SGOS#(diagnostics service-info) send 1-4974446 event_log system_information
snapshot_sysinfo
Sending the following reports
Event_log
System_information
Snapshot_sysinfo
SGOS#(diagnostics service-info) view status
Name
Transferred
Total Size
% Done
Event_log
Transferred successfully
Snapshot_sysinfo
Transferred successfully
Event_log
Transferred successfully
System_information
Transferred successfully
SGOS#(diagnostics service-info) exit
SGOS#(config diagnostics) exit
SGOS#(config)

#(config diagnostics) snapshot snapshot_name
This command allows you to edit a snapshot job.

Syntax
diagnostics

This changes the prompt to:
SGOS#(config diagnostics)
snapshot edit snapshot_name

102

Chapter 3: Privileged Mode Configure Commands

This changes the prompt to:
SGOS#(config snapshot snapshot_name)

- subcommandsoption 1: clear-reports
option 2: disable
option 3: enable
option 4: exit
option 5: interval minutes
option 6: keep number_to_keep (from 1 - 100)
option 7: take {infinite | number_to_take}
option 8: target object_to_fetch
option 9: view
Table 3.28: #(config snapshot snapshot_name)
clear-reports

Clears all stored snapshots reports.

disable

Disables this snapshot job.

enable

Enables this snapshot job.

exit

Exits configure diagnostics snapshot name
mode and returns to configure diagnostics
service-info mode.

interval

minutes

Specifies the interval between snapshots
reports in minutes.

keep

number_to_keep (from
1 - 100)

Specifies the number of snapshot reports to
keep.

take

infinite |
number_to_take

Specifies the number of snapshot reports to
take.

target

object_to_fetch

Specifies the object to snapshot.

view

Displays snapshot status and configuration.

Example
SGOS#(config) diagnostics
SGOS#(config diagnostics) snapshot testshot
SGOS#(diagnostics snapshot testshot) enable
ok
SGOS#(diagnostics service-info) interval 1440
ok
SGOS#(diagnostics snapshot testshot) exit
SGOS#(config diagnostics) exit
SGOS#(config)

#(config) dns
The dns command enables you to modify the DNS settings for the ProxySG. Note that the alternate
DNS servers are only checked if the servers in the standard DNS list return: “Name not found.”

103

Blue Coat ProxySG Command Line Interface Reference

Syntax
option 1: dns alternate ip_address
option 2: dns clear {alternate | imputing | resolving | server}
option 3: dns imputing name
option 4: dns no {alternate ip_address | imputing imputed_name | server ip_address}
option 5: dns server ip_address
Table 3.29: #(config) dns
alternate

ip_address

Adds the new alternate domain name server
indicated by ip_address to the alternate
DNS server list.

clear

alternate

Sets all entries in the alternate DNS server list
to null.

imputing

Sets all entries in the name imputing list to
null.

server

Sets all entries in the primary DNS server list
to null.

imputing

name

Identifies the file indicated by name as the
name imputing list.

no

alternate ip_address

Removes the alternate DNS server identified
by ip_address from the alternate DNS
server list.

imputing imputed_name

Removes the imputed name identified by
imputed_name from the name imputing list.

server ip_address

Removes the primary DNS server identified
by ip_address from the primary DNS
server list.

ip_address

Adds the new primary domain name server
indicated by ip_address to the primary
DNS server list.

server

Example
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok

dns clear server
dns server 10.253.220.249
dns clear alternate
dns alternate 216.52.23.101

#(config) dynamic-bypass
Dynamic bypass provides a maintenance-free method for improving performance of the ProxySG by
automatically compiling a list of requested URLs that return various kinds of errors.
With dynamic bypass, the ProxySG adds dynamic bypass entries, containing the server IP address of
sites that have returned an error, to the ProxySG’s local bypass list. For a configured period of time,

104

Chapter 3: Privileged Mode Configure Commands

further requests for the error-causing URL are sent immediately to the origin server, saving the
ProxySG processing time. The amount of time a dynamic bypass entry stays in the list, and the types
of errors that cause the ProxySG to add a site to the list, along with several other settings, is
configurable from the CLI.
Once the dynamic bypass timeout for a URL has ended, the ProxySG removes the URL from the
bypass list. On the next client request for the URL, the ProxySG attempts to contact the origin server. If
the origin server still returns an error, the URL is once again added to the local bypass list for the
configured dynamic bypass timeout. If the URL does not return an error, the request is handled in the
normal manner.
The performance gains realized with this feature are substantial if the client base is large, and clients
are requesting many error-causing URLs in a short period of time (for example, many users clicking a
browser’s refresh button over and over to get an overloaded origin server to load a URL). Dynamic
bypass increases efficiency because redundant attempts to contact the origin server are minimized.

Syntax
option 1: dynamic-bypass clear
option 2: dynamic-bypass disable
option 3: dynamic-bypass enable
option 4: dynamic-bypass no trigger {all | connect-error | non-http | receive-error
| 400 | 401 | 403 | 405 | 406 | 500 | 502 | 503 | 504}
option 5: dynamic-bypass trigger {all | connect-error | non-http | receive-error |
400 | 401 | 403 | 405 | 406 | 500 | 502 | 503 | 504}
Table 3.30: #(config) dynamic-bypass
clear

Clears all entries in the dynamic bypass list.

disable

Disables the current dynamic bypass list.

enable

Enables the current dynamic bypass list.

no trigger

all | connect-error |
non-http |
receive-error | 400 |
403 | 405 | 406 | 500 |
502 | 503 | 504

Disables dynamic bypass for the specified
HTTP response code, all HTTP response
codes, or all non-HTTP responses.

trigger

all | connect-error |
non-http |
receive-error | 400 |
403 | 405 | 406 | 500 |
502 | 503 | 504

Enables dynamic bypass for the specified
HTTP response code, all HTTP response
codes, or all non-HTTP responses.

Example
SGOS#(config) dynamic-bypass clear
ok
SGOS#(config) dynamic-bypass enable
WARNING:
Requests to sites that are put into the dynamic bypass list will
bypass future policy evaluation. This could result in subversion
of on-box policy. The use of dynamic bypass is cautioned.
ok

105

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config) dynamic-bypass trigger all
ok

#(config) event-log
You can configure the ProxySG to log system events as they occur. Event logging allows you to specify
the types of system events logged, the size of the event log, and to configure Syslog monitoring. The
ProxySG can also notify you by email if an event is logged.

Syntax
event-log

This changes the prompt to:
SGOS#(config event-log)

- subcommandsoption 1: exit
option 2: level {configuration | informational | policy | severe | verbose}
option 3: log-size megabytes
option 4: mail {add email_address | clear | no smtp-gateway | remove email_address
| smtp-gateway {domain_name | ip_address}}

option 5: syslog {disable | enable | facility {auth | daemon | kernel | local0 |
local1 | local2 | local3 | local4 | local5 | local6 | local7 | lpr | mail | news |
syslog | user | uucp} | loghost {domain_name | ip_address} | no loghost}
option 6: view [configuration]
option 7: when-full {overwrite | stop}
Table 3.31: #(config event-log)
exit
level

log-size

106

Exits configure event-log mode and returns to
configure mode.
configuration

Writes severe and configuration change error
messages to the event log.

informational

Writes severe, configuration change, policy
event, and information error messages to the
event log.

policy

Writes severe, configuration change, and
policy event error messages to the event log.

severe

Writes only severe error messages to the
event log.

verbose

Writes all error messages to the event log.

megabytes

Specifies the maximum size of the event log
in megabytes.

Chapter 3: Privileged Mode Configure Commands

Table 3.31: #(config event-log) (Continued)
mail

syslog

add email_address

Specifies an email recipient for the event log
output.

clear

Removes all email recipients from the event
log email output distribution list.

no smtp-gateway

Clears the SMTP gateway used for
notifications.

remove email_address

Removes the email recipient indicated by
email_address from the event log email
output distribution list.

smtp-gateway
{domain_name |
ip_address}

Specifies the SMTP gateway to use for event
log email output notifications.

disable

Disables the collection of system log
messages.

enable

Enables the collection of system log messages.

facility
daemon |
local0 |
local2 |
local4 |
local6 |
| mail |
| user |

{auth |
kernel |
local1 |
local3 |
local5 |
local7 | lpr
news | syslog
uucp}

Specifies the types of system log messages to
be collected in the system log.

loghost {domain_name |
ip_address}

Specifies the host domain used for system log
notifications.

no loghost

Clears the loghost setting.

view

[start [YYYY-mm-dd]
[HH:MM:SS]] [end
[YYYY-mm-dd]
[HH:MM:SS]] [regex
regex | substring
string]
[configuration]

View the event-log configuration, using
configuration, or view the contents of the
event-log, using the filters offered to narrow
the view.

when-full

{overwrite | stop}

Specifies what should happen to the event log
when the maximum size has been reached.
overwrite overwrites the oldest
information in a FIFO manner; stop disables
event logging.

Note:

You must replace the default Blue Coat Systems SMTP gateway with your gateway. If you do
not have access to an SMTP gateway, you can use the Blue Coat Systems gateway to send
event messages to Blue Coat Systems (the Blue Coat Systems SMTP gateway will only send
mail to Blue Coat Systems; it will not forward mail to other domains).

107

Blue Coat ProxySG Command Line Interface Reference

Example
SGOS#(config) event-log
SGOS#(config event-log) syslog enable
ok

108

Chapter 3: Privileged Mode Configure Commands

#(config) exceptions
These commands allow you to configure built-in and user-defined exception response objects.

Syntax
exceptions

This changes the prompt to:
SGOS#(config exceptions)

- subcommandsoption 1: create exception_id
option 2: company-name name
option 3: delete exception_id
option 4: edit exception_id or user_defined_exception_id—changes the prompt (see
“#(config exceptions) edit [user-defined.]exception_id” on page 110)
option 5: exit
option 6: inline {contact | details | format | help | http {contact | details |
format | help | summary} | summary} eof_marker
option 7: load exceptions
option 8: no path
option 9: path url
option 10: user-defined inline {contact | details | format | help | http {contact |
details | format | help | summary} | summary} eof_marker
Table 3.32: #(config exceptions)
create

exception_id

Creates the given exception.

company-name

name

Sets the name used for the
$(exception.company_name) substitution.

delete

exception_id

Deletes the exception specified by
exception_id.

edit

exception_id | user_
defined_exception_id

Changes the prompt. See “#(config
exceptions) edit
[user-defined.]exception_id” on
page 110.

exit

Exits configure exceptions mode and returns
to configure mode.

inline

{contact | details |
format | help | http
{contact | details |
format | help |
summary} | summary}
eof_marker

Configures defaults for all exception objects.

load

exceptions

Downloads new exceptions.

no

path

Clears the network path to download
exceptions.

109

Blue Coat ProxySG Command Line Interface Reference

Table 3.32: #(config exceptions) (Continued)
path

url

Specifies the network path to download
exceptions.

user-defined

inline {contact |
details | format |
help | http {contact |
details | format |
help | summary} |
summary} eof_marker

Configures the top-level values for
user-defined exceptions.

Example
SGOS#(config) exceptions
SGOS#(config exceptions) default contact
ok
SGOS#(config exceptions) exit
SGOS#(config)

#(config exceptions) edit [user-defined.]exception_id
These commands allow you to edit an exception or a user-defined exception.

Syntax
exceptions

This changes the prompt to:
SGOS#(config exceptions)
exception_id or user_defined_exception_id

This changes the prompt to:
SGOS#(config exceptions [user-defined.]exception_id)

- subcommandsoption 1: exit
option 2: http-code numeric_http_response_code
option 3: inline {contact | details | format | help | http {contact | details |
format | help | summary} | summary} eof_marker
Table 3.33: #(config exceptions [user-defined.]exception_id)
exit

110

Exits configure exceptions [user-defined]
exception_id mode and returns to configure
exceptions mode.

Chapter 3: Privileged Mode Configure Commands

Table 3.33: #(config exceptions [user-defined.]exception_id) (Continued)
http-code

numeric_http_
response_code

Configures this exception's HTTP response
code.

inline

{contact | details |
format | help | http
{contact | details |
format | help |
summary} | summary}
eof_marker

Configures this exception's substitution
values.

Example
SGOS#(config) exceptions
SGOS#(config exceptions) edit testname
SGOS#(config exceptions user-defined testname) http-code 000
ok
SGOS#(config exceptions user-defined testname) exit
SGOS#(config exceptions) exit
SGOS#(config)

#(config) exit
Exits from Configuration mode to Privileged mode, from Privileged mode to Standard mode. From
Standard mode, the exit command closes the CLI session.

Syntax
exit

The exit command does not have any parameters or subcommands.

#(config) external-services
These commands allow you to configure your external services.
Use the edit ICAP commands to configure the ICAP service used to integrate the ProxySG with a virus
scanning server. The configuration is specific to the virus scanning server and includes the server IP
address, as well as the supported number of connections. If you are using the ProxySG with multiple
virus scanning servers or multiple scanning services on the same server, add an ICAP service for each
server or scanning service.
Note:

When you define virus scanning policies, use the same service name. Make sure you type the
ICAP service name accurately, whether you are configuring the service on the ProxySG or
defining policies since the name retrieves the other configuration settings for that service.

Syntax
external-services

This changes the prompt to:
SGOS#(config external-services)

111

Blue Coat ProxySG Command Line Interface Reference

- subcommandsoption 1: create {icap icap_service_name | service-group service_group_name |
websense websense_service_name}

option 2: delete name
option 3: edit—changes the prompt to one of three external service edit commands:
sub-option 1: icap_service_name (see “#(config external-services) edit
icap_service_name” on page 113)
sub-option 2: service_group_name (see “#(config external-services) edit
service_group_name” on page 115)
sub-option 3: websense_service_name (see “#(config external-services) edit
websense_service_name” on page 116)

option 4: exit
option 5: inline
sub-option 1: http {icap-patience-details | icap-patience-header |
icap-patience-help | icap-patience-summary}
sub-option 2: ftp icap-patience-details

option 6: view
Table 3.34: #(config external-services)
create

icap icap_service_name

Creates an ICAP service.

service-group
service_group_name

Creates a service group.

websense
websense_service_name

Creates a Websense service.

delete

name

Deletes an external service.

edit

icap_service_name

Changes the prompt. See “#(config
external-services) edit
icap_service_name” on page 113.

service_group_name

Changes the prompt. See “#(config
external-services) edit
service_group_name” on page 115.

websense_service_name

Changes the prompt. See “#(config
external-services) edit
websense_service_name” on page 116.

exit

112

Exits configure external-services mode and
returns to configure mode.

Chapter 3: Privileged Mode Configure Commands

Table 3.34: #(config external-services) (Continued)
inline

http {icap-patiencedetails eof_marker |
icap-patience-header
eof_marker} |
icap-patience-help
eof_marker |
icap-patience-summary
eof_marker}

Customizes ICAP patience page details for
HTTP connections.

ftp
icap-patience-details

Customizes ICAP patience page details for
FTP connections.

view

Shows external services and external service
groups.

Example
SGOS#(config) external-services
SGOS#(config external-services) create websense testwebsense
ok
SGOS#(config external-services) exit
SGOS#(config)

#(config external-services) edit icap_service_name
These commands allow you to edit ICAP parameters.

Syntax
external-services

This changes the prompt to:
SGOS#(config external-services)
edit icap_service_name

This changes the prompt to:
SGOS#(config icap icap_service_name)

- subcommandsoption 1: exit
option 2: max-conn max_num_connections
option 3: methods {REQMOD | RESPMOD}
option 4: no
sub-option 1: send {client-address | server-address}
sub-option 2: notify virus-detected
sub-option 3: patience-page
sub-option 4: preview

option 5: notify virus-detected
option 6: patience-page seconds

113

Blue Coat ProxySG Command Line Interface Reference

option 7: preview-size bytes
option 8: send {client-address | server-address}
option 9: sense-settings
option 10: timeout seconds
option 11: url url
option 12: view
Table 3.35: #(config icap icap_service_name)
exit

Exits configure ICAP name mode and returns
to configure external-services mode.

max-conn

max_num_connections

Sets the maximum number of connections for
the ICAP service.

methods

REQMOD | RESPMOD

Sets the method supported by the ICAP
service. REQMOD is request modification
and RESPMOD is response modification.

no

send {client-address |
server-address}

Specifies what should not be sent to the ICAP
server.

notify virus-detected

Specifies no notification to the administrator
when a virus is detected.

patience-page

Specifies that patience pages do not get
served.

preview

Specifies that previews do not get sent.

notify virus-detected

Specifies notification when viruses are found.

patience-page

seconds

Sets the number of seconds (5 to 65535) to
wait before serving a patience page.

preview-size

bytes

Sets the preview size for the ICAP service.

send

client-address

Specifies that the client address be sent to the
ICAP service.

server-address

Specifies that the server address be sent to the
ICAP service.

sense-settings

Senses the service’s setting by contacting the
server.

timeout

seconds

Sets the connection timeout for the ICAP
services.

url

url

Sets the URL for the ICAP services.

view

Displays the service’s current configuration.

Example
SGOS#(config) external-services
SGOS#(config external-services) edit testicap
SGOS#(config icap testicap) send client-address
ok
SGOS#(config icap testicap) exit
SGOS#(config external-services) exit
SGOS#(config)

114

Chapter 3: Privileged Mode Configure Commands

#(config external-services) edit service_group_name
These commands allow you to edit service group parameters.

Syntax
external-services

This changes the prompt to:
SGOS#(config external-services)
edit service_group_name

This changes the prompt to:
SGOS#(config service-group service_group_name)

- subcommandsoption 1: add entry_name
option 2: edit entry_name—changes the prompt (see “#(config service-group
service_group_name) edit entry_name” on page 116)

option 3: exit
option 4: remove entry_name
option 5: view
Table 3.36: #(config service-group service_group_name)
add

entry_name

Adds an entry to this service group.

edit

entry_name

Edits an entry in this service group. Changes the
prompt (see “#(config service-group
service_group_name) edit entry_name”
on page 116).

exit
remove
view

Exits configure service-group name mode and
returns to configure external-services mode.
entry_name

Removes an entry from this service group.
Displays this service group’s configuration.

Example
SGOS#(config) external-services
SGOS#(config external-services) edit testgroup
SGOS#(config service-group testgroup) add testentry
ok
SGOS#(config service-group testgroup) exit
SGOS#(config external-services) exit
SGOS#(config)

115

Blue Coat ProxySG Command Line Interface Reference

#(config service-group service_group_name) edit entry_name
These commands allow you to edit a service group entry.

Syntax
external-services

This changes the prompt to:
SGOS#(config external-services)
edit service_group_name

This changes the prompt to:
SGOS#(config service-group service_group_name)
edit entry_name

This changes the prompt to:
SGOS#(config service-group service_group_name entry_name)

- subcommandsoption 1: exit
option 2: view
option 3: weight 0 to 255
Table 3.37: #(config service-group service_group_name entry_name)
exit

Exits configure service-group name/entry name
mode and returns to configure service-group
name mode.

view

Shows this entry’s configuration.

weight

0 to 255

Modifies this entry’s weight.

Example
SGOS#(config) external-services
SGOS#(config external-services) edit testgroup
SGOS#(config service-group testgroup) edit testentry
SGOS#(config service-group testgroup testentry) weight 223
ok
SGOS#(config service-group testgroup testentry) exit
SGOS#(config service-group testgroup) exit
SGOS#(config external-services) exit
SGOS#(config)

#(config external-services) edit websense_service_name
These commands allow you to edit Websense parameters.

Syntax
external-services

116

Chapter 3: Privileged Mode Configure Commands

This changes the prompt to:
SGOS#(config external-services)
edit websense_service_name

This changes the prompt to:
SGOS#(config websense websense_service_name)

- subcommandsoption 1: apply-by-default
option 2: exit
option 3: fail-open
option 4: host host
option 5: max-conn max_num_connections
option 6: no {apply-by-default | fail-open | send {client-address | client-info} |
serve-exception-page}
option 7: port port
option 8: send {client-address | client-info}
option 9: sense-categories
option 10: serve-exception-page
option 11: test-url url
option 12: timeout seconds
option 13: version {4.3 | 4.4}
option 14: view
Table 3.38: #(config websense websense_service_name)
apply-by-default

Applies Websense by default.

exit

Exits configure websense name mode and returns
to configure external-services mode.

fail-open

Fail open if service is applied by default.

host

host

Remote Websense hostname or IP address.

max-conn

max_num_connections

Specifies the maximum number of concurrent
connections.

no

apply-by-default

Will not apply service by default.

fail-open

Fail closed if service is applied by default.

send {client-address
| client-info}

Negates send options.

serve-exception-page

Serves Websense message when content is
blocked.

port

port

Port number of remote Websense server.

send

client-address

Sends the client address to the Websense server.

client-info

Sends the client information to the Websense
server.

117

Blue Coat ProxySG Command Line Interface Reference

Table 3.38: #(config websense websense_service_name) (Continued)
sense-categories

Sense categories configured on the Websense
server.

serve-exceptionpage

Serves built-in exception page when content is
blocked.
url

Tests a url against the Websense server.

timeout

seconds

Sets the receive timeout in seconds.

version

4.3 | 4.4

Sets the version of the Websense server.

test-url

view

Displays the service's current configuration.

Example
SGOS#(config) external-services
SGOS#(config external-services) edit testwebsense
SGOS#(config websense testwebsense) send client-address
ok
SGOS#(config websense testwebsense) exit
SGOS#(config external-services) exit
SGOS#(config)

#(config) failover
These commands allow you to configure redundancy into your network.

Syntax
failover

This changes the prompt to:
SGOS#(config failover)

- subcommandsoption 1: create group_address
option 2: edit group_address—changes the prompt (see “#(config failover) edit
group_address” on page 119)

option 3: exit
option 4: delete group_address
Table 3.39: #(config failover)
create

group_address

Creates a failover group.

edit

group_address

Changes the prompt. See “#(config
failover) edit group_address” on
page 119.

exit
delete

118

Exits configure failover mode and returns to
configure mode.
group_address

Deletes a failover group.

Chapter 3: Privileged Mode Configure Commands

Example
SGOS#(config) failover
SGOS#(config failover) create 10.9.17.135
ok
SGOS#(config failover) exit
SGOS#(config)

#(config failover) edit group_address
These commands allow you to edit your failover group settings.

Syntax
failover

This changes the prompt to:
SGOS#(config failover)
edit group_address

This changes the prompt to:
SGOS#(config failover group_address)

- subcommandsoption 1: disable
option 2: enable
option 3: encrypted-secret encrypted_secret
option 4: exit
option 5: interval interval_in_seconds
option 6: master
option 7: multicast-address multicast_address
option 8: no {interval | multicast-address | master | priority | secret}
option 9: priority relative_priority
option 10: secret secret
option 11: view
Table 3.40: #(config failover group_address)
disable

Disables failover group indicated by
group_address.

enable

Enables failover group indicated by
group_address.

encrypted-secret

exit

encrypted_secret

(Optional but recommended) Refers to an
encrypted password shared only with the
group.
Exits configure failover group_address mode
and returns to configure failover mode.

119

Blue Coat ProxySG Command Line Interface Reference

Table 3.40: #(config failover group_address) (Continued)
interval

interval_in_seconds

master

(Optional) Refers to the time between
advertisements from the master to the multicast
address. The default is 40 seconds.
Defines the current system as the master and all
other systems as slaves.

multicast-address

multicast_address

Refers to a multicast address where the master
sends the keepalives (advertisements) to the
slave systems.

no

interval

Resets the interval to the default value (40
seconds).

multicast-address

Removes the multicast address from the failover
group.

master

Removes as configured master.

priority

Resets the priority to the default value (100).

secret

Clears the secret from the failover group.

priority

relative_priority

(Optional) Refers to the rank of slave systems.
The range is from 1 to 253. (The master system,
the one whose IP address matches the group
address, gets 254.)

secret

secret

(Optional but recommended) Refers to a
password shared only with the group. You can
create a secret, which will then be hashed.

view

Shows the current settings for the failover group
indicated by group_address.

Example
SGOS#(config) failover
SGOS#(config failover) edit 10.25.36.47
SGOS#(config failover 10.25.36.47) master
ok
SGOS#(config failover 10.25.36.47) exit
SGOS#(config failover) exit
SGOS#(config)

#(config) forwarding
The ProxySG supports the forwarding of content requests to defined hosts and groups through policy.
You must add each host and group to use in forwarding content requests. To define a group, add a
host and use the group= subcommand to add a group. Add up to 512 hosts and up to 32 groups.
To set the default load-balancing and host-affinity values, use the (config forwarding)
load-balance or (config forwarding)host-affinity commands. However, three methods are
available to set per host or per group settings. You can:

120



Use the (config forwarding) create command.



Use the (config forwarding) load-balance or (config forwarding) host-affinity
commands.

Chapter 3: Privileged Mode Configure Commands



Use the (config forwarding host_alias) or (config forwarding group_alias) commands
(see “#(config forwarding) edit host_alias” on page 125 or“#(config forwarding) edit
group_alias” on page 124).

After adding forwarding hosts and groups, you can create a default sequence, which provides you
with default forwarding and failover capabilities in the event that no policy gestures apply. However,
Blue Coat does not recommend that you use the default sequence as a substitute for fully specifying
forwarding behavior in policy.
A default failover sequence (and any sequence specified in policy) works by allowing healthy hosts to
take over for an unhealthy host (one that is failing its DNS Resolution or its health check). The
sequence specifies the order of failover, with the second host taking over for the first host, the third
taking over for the second, and so on. All members must be pre-existing hosts and groups, and no
member can be in the group more than once.
Note:

The default sequence replaces the deprecated default and backup settings. The default
sequence (if present) is applied only if no applicable forwarding gesture is in policy.

The ProxySG automatically performs health checks for all forwarding hosts. When the ProxySG
performs a health check, it determines whether the host returns a response and is available to fulfill a
content request. A positive health check indicates:


An end-to-end connection exists.



The host is up and running and will most likely be able to return a response.

Syntax
forwarding

This changes the prompt to:
SGOS#(config forwarding)

- subcommandsoption 1: create {host_alias host_name [default-schemes] [http[=port | =no]]
[https[=port | =no]] [ftp[=port | =no]] [mms[=port | =no]] [rtsp[=port | =no]]
[tcp=port] [telnet[=port | =no]] [ssl-verify-server[=yes | =no]] [group=group_name]
[server | proxy] [load-balance={no | round-robin | least-connections}]
[host-affinity={no | client-ip-address | accelerator-cookie}]
[host-affinity-ssl={no | client-ip-address | accelerator-cookie | ssl-session-id}]}
option 2: delete {all | group group_name | host host_alias}
option 3: download-via-forwarding {disable | enable}
option 4: edit host_or_group_alias—changes the prompt (see either “#(config forwarding)
edit group_alias” on page 124 or “#(config forwarding) edit host_alias” on page 125)

option 5: exit
option 6: failure-mode {closed | open}
option 7: host-affinity
sub-option 1: method {accelerator-cookie [host_or_group_alias] | client-ip-address
[host_or_group_alias] | default host_or_group_alias | no [host_or_group_alias]}

121

Blue Coat ProxySG Command Line Interface Reference

sub-option 2: ssl-method {accelerator-cookie [host_or_group_alias] |
client-ip-address [host_or_group_alias] | default host_or_group_alias | no
[host_or_group_alias] | ssl-session-id [host_or_group_alias]}
sub-option 3: timeout minutes

option 8: integrated-host-timeout minutes
option 9: load-balance
sub-option 1: hash {default group_alias | domain [group_alias] | no [group_alias]
| url [group_alias]}
sub-option 2: method {default host_or_group_alias | least-connections
[host_or_group_alias] | no [host_or_group_alias] | round-robin
[host_or_group_alias]}

option 10: no path
option 11: path url
option 12: sequence
sub-option 1: add host_or_group_alias
sub-option 2: clear
sub-option 3: demote host_or_group_alias
sub-option 4: promote host_or_group_alias
sub-option 5: remove host_or_group_alias

option 13: view
Table 3.41: #(config forwarding)
create

Creates a forwarding host/group. The only
required entries under the create option
(for a host) are host_alias, host_name,
a protocol, and a port number. The port
number can be defined explicitly (i.e.,
http=8080), or it can take on the default
port value of the protocol, if one exists (i.e.,
enter http, and the default port value of
80 is entered automatically).
To create a host group, you must also
include the group=group_name
command. If this is the first mention of the
group, group_name, then that group is
automatically created with this host as its
first member. Do not use this command
when creating an independent host.

delete

download-via-forwarding

122

all

Deletes all forwarding hosts and groups.

group group_name

Deletes only the group identified by
group_name.

host host_alias

Deletes only the host identified by
host_alias.

disable | enable

Disables or enables configuration file
downloading using forwarding.

Chapter 3: Privileged Mode Configure Commands

Table 3.41: #(config forwarding) (Continued)
edit

host_or_group_alias

exit

Changes the prompt. See either“#(config
forwarding) edit group_alias” on
page 124 or“#(config forwarding)
edit host_alias” on page 125.
Exits configure forwarding mode and
returns to configure mode.

failure-mode

closed | open

Sets the default forwarding failure mode to
closed or open.

host-affinity

method
{accelerator-cookie
[host_or_group_alias] |
client-ip-address
[host_or_group_alias] |
default
host_or_group_alias |
no
[host_or_group_alias]}

Selects a host affinity method (non-SSL). If
a host or group alias is not specified for the
accelerator-cookie,
client-ip-address, or no options, the
global default is used. Use the default
option to specify default configurations for
all the settings for a specified host or group.

ssl-method
{accelerator-cookie
[host_or_group_alias] |
client-ip-address
[host_or_group_alias] |
default
host_or_group_alias |
no
[host_or_group_alias] |
ssl-session-id
[host_or_group_alias]}

Selects a host affinity method for SSL. If a
host or group alias is not specified for the
accelerator-cookie,
client-ip-address, no, or
ssl-session-id options, the global
default is used. Use the default option to
specify default configurations for all the
settings for a specified host or group.

timeout minutes

Sets the timeout in minutes for the host
affinity.

integrated-host-timeout

minutes

Sets the timeout for aging out unused
integrated hosts.

load-balance

hash {default
group_alias | domain
[group_alias] | url
[group_alias] | no
[group_alias]}

Sets if and how load balancing hashes
between group members. If a group alias is
not specified for the domain, url, or no
options, the global default is used. Use the
default option to specify default
configurations for all the settings for a
specified group

method {default
host_or_group_alias |
least-connections
[host_or_group_alias] |
round-robin
[host_or_group_alias] |
no
[host_or_group_alias]}

Sets the load balancing method. If a host or
group alias is not specified for the
least-connections, round-robin, or
no options, the global default is used. Use
the default option to specify default
configurations for all the settings for a
specified host or group.

no path

Negates certain forwarding settings.

123

Blue Coat ProxySG Command Line Interface Reference

Table 3.41: #(config forwarding) (Continued)
path

url

Sets the network path to download
forwarding settings.

sequence

add host_or_group_alias

Adds an alias to the end of the default
failover sequence.

clear

Clears the default failover sequence.

demote
host_or_group_alias

Demotes an alias one place towards the end
of the default failover sequence.

promote
host_or_group_alias

Promotes an alias one place towards the
start of the default failover sequence.

remove
host_or_group_alias

Removes an alias from the default failover
sequence.

view

Displays the currently defined forwarding
groups or hosts.

Example
SGOS#(config) forwarding
SGOS#(config forwarding)
ok
SGOS#(config forwarding)
ok
SGOS#(config forwarding)
ok
SGOS#(config forwarding)
ok
SGOS#(config forwarding)
SGOS#(config)

download-via-forwarding disable
failure-mode closed
host-affinity method client-ip-address
load-balance hash domain group_name1
exit

#(config forwarding) edit group_alias
These commands allow you to edit the settings of a specific forwarding group.

Syntax
forwarding

This changes the prompt to:
SGOS#(config forwarding)
edit group_alias

This changes the prompt to:
SGOS#(config forwarding group_alias)

- subcommandsoption 1: exit
option 2: host-affinity
sub-option 1: method {accelerator-cookie | client-ip-address | default}

124

Chapter 3: Privileged Mode Configure Commands

sub-option 2: ssl-method {accelerator-cookie | client-ip-address | default |
ssl-session-id}

option 3: load-balance
sub-option 1: hash {default | domain | url}
sub-option 2: method {default | least-connections | round-robin}

option 4: no
sub-option 1: host-affinity {method | ssl-method}
sub-option 2: load-balance {hash | method}

option 5: view
Table 3.42: #(config forwarding group_alias)
exit

host-affinity

load-balance

no

Exits configure forwarding group_alias
mode and returns to configure forwarding
mode.
method
{accelerator-cookie |
client-ip-address |
default}

Changes the host affinity method (non-SSL)
for this group.

ssl-method
{accelerator-cookie |
client-ip-address |
default |
ssl-session-id}

Changes the host affinity method (SSL) for
this group.

hash {default | domain
| url}

Changes if and how load balancing hashes
between group members.

method {default |
least-connections |
round-robin}

Changes the load balancing method.

host-affinity {method |
ssl-method}

Disables a host affinity setting for this
group.

load-balance {hash |
method}

Disables a load balancing setting for this
group.

view

Shows the current settings for this
forwarding group.

Example
SGOS#(config) forwarding
SGOS#(config forwarding) edit test_group
SGOS#(config forwarding test_group) load-balance hash domain
ok
SGOS#(config forwarding test_group) exit
SGOS#(config forwarding) exit
SGOS#(config)

#(config forwarding) edit host_alias
These commands allow you to edit the settings of a specific forwarding host.

125

Blue Coat ProxySG Command Line Interface Reference

Syntax
forwarding

This changes the prompt to:
SGOS#(config forwarding)
edit host_alias

This changes the prompt to:
SGOS#(config forwarding host_alias)

- subcommandsoption 1: exit
option 2: ftp [port]
option 3: group group_name
option 4: host host_name
option 5: host-affinity
sub-option 1: method {accelerator-cookie | client-ip-address | default}
sub-option 2: ssl-method {accelerator-cookie | client-ip-address | default |
ssl-session-id}

option 6: http [port]
option 7: https [port]
option 8: load-balance method {default | least-connections | round-robin}
option 9: mms [port]
option 10: no {ftp | group | host-affinity {method | ssl-method} | http | https |
load-balance method | mms | rtsp | ssl-verify-server | tcp | telnet}
option 11: proxy
option 12: rtsp [port]
option 13: server
option 14: ssl-verify-server
option 15: tcp port
option 16: telnet [port]
option 17: view
Table 3.43: #(config forwarding host_alias)
exit

ftp

126

Exits configure forwarding host_alias
mode and returns to configure forwarding
mode.
[port]

Changes the FTP port to the default port or
to a port that you specify.

Chapter 3: Privileged Mode Configure Commands

Table 3.43: #(config forwarding host_alias) (Continued)
group

group_name

Specifies the group (or server farm or group
of proxies) to which this host belongs.
The ProxySG uses load balancing to evenly
distribute forwarding requests to the origin
servers or group of proxies. Do not use the
group option when creating independent
hosts.

host

host_name

Changes the host name.

host-affinity

method
{accelerator-cookie |
client-ip-address |
default}

Changes the host affinity method (non-SSL)
for this host.

ssl-method
{accelerator-cookie |
client-ip-address |
default |
ssl-session-id}

Changes the host affinity method (SSL) for
this host.

http

[port]

Changes the HTTP port to the default port
or to a port that you specify.

https

[port]

Changes the HTTPS port to the default port
or to a port that you specify.

load-balance

method {default |
least-connections |
round-robin}

Changes the load balancing method.

mms

[port]

Changes the MMS port to the default port
or to a port that you specify.

no

ftp | group |
host-affinity {method |
ssl-method} | http |
https | load-balance
method | mms | rtsp |
ssl-verify-server | tcp
| telnet

Deletes a setting for this host.

proxy
rtsp

Makes the host a proxy instead of a server;
any HTTPS or TCP port will be deleted.
[port]

server

Changes the RTSP port to the default port
or to a port that you specify.
Makes the host a server instead of a proxy.

ssl-verify-server

Sets SSL to verify server certificates.

tcp

port

Changes the TCP port.

telnet

[port]

Changes the Telnet port to the default port
or to a port that you specify.

view

Shows the current settings for this
forwarding host.

127

Blue Coat ProxySG Command Line Interface Reference

Example
SGOS#(config) forwarding
SGOS#(config forwarding) edit test_host
SGOS#(config forwarding test_host) server
ok
SGOS#(config forwarding test_host) exit
SGOS#(config forwarding) exit
SGOS#(config)

#(config) ftp
Use this command to configure FTP parameters.

Syntax
option 1: ftp login-syntax {raptor | checkpoint}
option 2: ftp no welcome-banner
option 3: ftp welcome-banner banner
Table 3.44: #(config) ftp
login-syntax

{raptor | checkpoint}

no welcome-banner
welcome-banner

Toggles between Raptor and Checkpoint login
syntax. The default is raptor.
No text is displayed to an FTP client when a
connection occurs.

banner

Customizes the text displayed to an FTP client
when a connection occurs.

#(config) health-check
Use this command to configure health check settings.
Note:

Using the pause command to temporarily pause the forwarding or SOCKS gateways health
checks causes the system to stay in pause mode until you use the resume command to end
it—rebooting the system will not cause paused health checks to resume.

Syntax
health-check

This changes the prompt to:
SGOS#(config health-check)

- subcommandsoption 1: create entry_name
option 2: delete entry_name
option 3: edit entry_name—changes the prompt (see “#(config health-check) edit
entry_name” on page 130)

128

Chapter 3: Privileged Mode Configure Commands

option 4: exit
option 5: forwarding
sub-option 1: failcount count
sub-option 2: interval seconds
sub-option 3: pause
sub-option 4: resume
sub-option 5: type {http object | https object | layer-3 | layer-4}

option 6: socks-gateways
sub-option 1: failcount count
sub-option 2: interval seconds
sub-option 3: pause
sub-option 4: resume
sub-option 5: type {layer-3 | layer-4}

option 7: statistics
option 8: view
Table 3.45: #(config health-check)
create

entry_name

Adds a health check entry specified by
entry_name.

delete

entry_name

Deletes the specified health check entry.

edit

entry_name

Changes the prompt. See “#(config
health-check) edit entry_name” on
page 130.

exit
forwarding

Exits configure health check mode and
returns to configure mode.
failcount count

Configures the forwarding health check
failure count.

interval seconds

Configures the forwarding health check
interval in seconds.

pause

Pauses the forwarding health checks
temporarily (the system remains in pause
mode until you use the resume command
to end it).

resume

Resumes the forwarding health checks.

type {http object |
https object | layer-3
| layer-4}

Configures the forwarding health check
type.

129

Blue Coat ProxySG Command Line Interface Reference

Table 3.45: #(config health-check) (Continued)
socks-gateways

failcount count

Configures the SOCKS gateways health
check failure count.

interval seconds

Configures the SOCKS gateways health
check interval in seconds.

pause

Pauses the SOCKS gateways health checks
temporarily (the system remains in pause
mode until you use the resume command
to end it).

resume

Resumes the SOCKS gateways health
checks.

type {layer-3 |
layer-4}

Configures the SOCKS gateways health
check type.

show health-check

Displays health check settings for layer-3
and layer-4 types. This command does not
show ICAP or Websense 4 settings.

statistics

Displays health check statistics.

view

Displays the current health check
configurations for forwarding and SOCKS
gateways settings.

Example
SGOS#(config) health-check
SGOS#(config health-check) socks-gateways type layer-3
ok
SGOS#(config health-check) exit
SGOS#(config)

#(config health-check) edit entry_name
Use this command to edit health check entries.

Syntax
health-check

This changes the prompt to:
SGOS#(config health-check)
edit entry_name

This changes the prompt to:
SGOS#(config health-check entry_name)

- subcommandsoption 1: exit
option 2: failure-trigger trigger
option 3: http url url
option 4: https url url

130

Chapter 3: Privileged Mode Configure Commands

option 5: icap service-name service_name
option 6: interval
sub-option 1: healthy interval_in_seconds
sub-option 2: sick interval_in_seconds

option 7: layer-3 hostname hostname
option 8: layer-4
sub-option 1: hostname hostname
sub-option 2: port port

option 9: no notify
option 10: notify
option 11: perform-health-check
option 12: statistics
option 13: threshold
sub-option 1: healthy threshold
sub-option 2: sick threshold

option 14: type {layer-3 | layer-4 | http | https | icap | websense4-offbox}
option 15: view
option 16: websense-offbox {default-url | service-name service_name | url test_url}
Table 3.46: #(config health-check entry_name)
exit

Exits configure health check entry_name
mode and returns to configure health check
mode.

failure-trigger

trigger

Sets failure count to trigger a health check.

http url

url

Configures HTTP health check parameters.

https url

url

Configures HTTPS health check
parameters.

icap service-name

service_name

Configures ICAP health check parameters.

interval

healthy
interval_in_seconds

Configures the health check healthy
intervals.

sick
interval_in_seconds

Configures the health check sick intervals.

layer-3 hostname

hostname

Configures layer-3 health check parameters.

layer-4 hostname

hostname

Configures layer-4 health check parameters.

no notify

Disables email notification of state changes.

notify

Enables email notification of state changes.

perform-health-check

Performs a health check.

statistics
threshold

Shows current health check statistics.
healthy threshold

The number of successful checks before a
transition to healthy.

sick threshold

The number of failed checks before a
transition to sick.

131

Blue Coat ProxySG Command Line Interface Reference

Table 3.46: #(config health-check entry_name) (Continued)
type

layer-3

Performs layer-3 health checks.

layer-4

Performs layer-4 health checks.

http

Performs HTTP health checks.

https

Performs HTTPS health checks.

icap

Performs ICAP health checks.

websense4-offbox

Performs Websense health checks.

view
websense-offbox

Shows the entry’s current configuration.
default-url

Uses the default Websense URL for health
checks.

service-name
service_name

Configures the Websense service-name to
health check.

url test_url

Configures the Websense URL to health
check.

Example
SGOS#(config) health-check
SGOS#(config health-check) edit testhealthcheck
SGOS#(config health-check testhealthcheck) type https
ok
SGOS#(config health-check testhealthcheck) exit
SGOS#(config health-check) exit
SGOS#(config)

#(config) hide-advanced
See “# hide-advanced” on page 27 in Chapter 2: Standard and Privileged Mode Commands.

#(config) hostname
Use this command to assign a name to a ProxySG. Any descriptive name that helps identify the
system will do.

Syntax
option 1: hostname name
Table 3.47: #(config) hostname
name

Associates name with the current ProxySG.

Example
SGOS#(config) hostname "Blue Coat Systems Demo"
ok

#(config) http
Use this command to configure HTTP settings.

132

Chapter 3: Privileged Mode Configure Commands

Syntax
option 1: http add-header {client-ip | front-end-https | via | x-forwarded-for}
option 2: http byte-ranges
option 3: http cache {authenticated-data | expired | personal-pages | reverse-dns}
option 4: http force-ntlm
option 5: http ftp-proxy-url {root-dir | user-dir}
option 6: http no
sub-option 1: add-header {client-ip | front-end-https | via | x-forwarded-for}
sub-option 2: byte-ranges
sub-option 3: cache {authenticated-data | expired | personal-pages | reverse-dns}
sub-option 4: force-ntlm
sub-option 5: parse meta-tag cache-control | expires | pragma-no-cache
sub-option 6: persistent {client | server}
sub-option 7: pipeline {client {requests | redirects} | prefetch {requests |
redirects}}
sub-option 8: proprietary-headers bluecoat
sub-option 9: revalidate-pragma-no-cache
sub-option 10: ssl-verify-server
sub-option 11: strict-expiration {refresh | serve}
sub-option 12: strip-from-header
sub-option 13: substitute {conditional | ie-reload | if-modified-since |
pragma-no-cache}
sub-option 14: tolerant-request-parsing
sub-option 15: www-redirect
sub-option 16: xp-rewrite-redirect

option 7: http parse meta-tag cache-control | expires | pragma-no-cache
option 8: http persistent {client | server}
option 9: http persistent-timeout {client | server}
option 10: http pipeline {client {requests | redirects} | prefetch {requests |
redirects}}

option 11: http proprietary-headers bluecoat
option 12: http receive-timeout {client | refresh | server}
option 13: http revalidate-pragma-no-cache
option 14: http ssl-verify-server
option 15: http strict-expiration {refresh | serve}
option 16: http strip-from-header
option 17: http substitute {conditional | ie-reload | if-modified-since |
pragma-no-cache}

option 18: http tolerant-request-parsing

133

Blue Coat ProxySG Command Line Interface Reference

option 19: http upload-with-pasv {disable | enable}
option 20: http version {1.0 | 1.1}
option 21: http www-redirect
option 22: xp-rewrite-redirect
Table 3.48: #(config) http
add-header

client-ip

Adds the client-ip header to
forwarded requests.

front-end-https

Adds the front-end-https header to
forwarded requests.

via

Adds the via header to forwarded
requests.

x-forwarded-for

Adds the x-forwarded-for header to
forwarded requests.

byte-ranges

Enables HTTP byte-range support.
If byte-range support is disabled, then
HTTP will treat all byte range requests as
non-cacheable. This means that HTTP
will never even check to see whether the
object is in the cache, but will forward the
request to the origin-server and not cache
the result. So the range request will have
no affect on the cache. For instance, if the
object was in the cache before a range
request, then it would still be in the cache
afterward—the range request will not
delete any currently cached objects. Also,
the Range header is not modified when
forwarded to the origin-server.
If the requested byte range is type 3 or 4,
then the request is treated as if byte-range
support is disabled. That is, the request is
treated as non-cacheable and will not
have any affect on objects in the cache.

cache

authenticated-data

Caches any data that appears to be
authenticated.

expired

Retains cached objects older than the
explicit expiration.

personal-pages

Caches objects that appear to be personal
pages.

reverse-dns

Stores objects under the name of the
associated host instead of the IP address.

force-ntlm
ftp-proxy-url

134

Uses NTLM for Microsoft Internet
Explorer proxy.
root-dir

URL path is absolute in relation to the
root.

user-dir

URL path is relative to the user’s home
directory.

Chapter 3: Privileged Mode Configure Commands

Table 3.48: #(config) http (Continued)
no

parameter

Negates the specified command.

parse meta-tag

cache-control | expires
| pragma-no-cache

Parses HTML objects for the
cache-control, expires, and
pragma-no-cache meta-tags.

persistent

client

Enables support for persistent client
requests from the browser.

server

Enables support for persistent server
requests to the Web server.

client num_seconds

Sets persistent connection timeout for the
client to num_seconds.

server num_seconds

Sets persistent connection timeout for the
server to num_seconds.

client {redirects |
requests}

Prefetches either embedded objects in
client requests or redirected responses to
client requests.

prefetch {redirects |
requests}

Prefetches either embedded objects in
pipelined objects or redirected responses
to pipelined requests.

proprietary-headers

bluecoat

Enables the Blue Coat Systems
proprietary HTTP header extensions.

receive-timeout

client num_seconds

Sets receive timeout for client to
num_seconds.

refresh num_seconds

Sets receive timeout for refresh to
num_seconds.

server num_seconds

Sets receive timeout for server to
num_seconds.

persistent-timeout

pipeline

revalidate-pragma-nocache

Revalidates "Pragma: no-cache."

ssl-verify-server

Enables verification of server certificate
during an HTTPS connection (overridden
by forwarding).

strict-expiration

strip-from-header

refresh

Forces compliance with explicit
expirations by never refreshing objects
before their explicit expiration.

serve

Forces compliance with explicit
expirations by never serving objects after
their explicit expiration.
Removes HTTP information from
headers.

135

Blue Coat ProxySG Command Line Interface Reference

Table 3.48: #(config) http (Continued)
substitute

conditional

Uses an HTTP "get" in place of HTTP 1.1
conditional get

ie-reload

Uses an HTTP "get" for Microsoft Internet
Explorer reload requests.

if-modified-since

Uses an HTTP "get" instead of
"get-if-modified."

pragma-no-cache

Uses an HTTP "get" instead of "get
pragma: no-cache."

tolerant-request-parsing

no

Enables or disables the HTTP
tolerant-request-parsing flag.

upload-with-pasv

disable

Disables uploading with Passive FTP.

enable

Enables uploading with Passive FTP.

1.0

Indicates the version of HTTP that should
be used by the ProxySG.

version

1.1
www-redirect

Redirects to www.host.com if host not
found.

xp-rewrite-redirect

Rewrites origin server 302s to 307s for
Windows XP IE requests.

Example
SGOS#(config) http version 1.1
ok
SGOS#(config) http byte-ranges
ok
SGOS#(config) http no force-ntlm
ok
SGOS#(config)

#(config) icp
ICP is a caching communication protocol. It allows a cache to query other caches for an object, without
actually requesting the object. By using ICP, the ProxySG determines if the object is available from a
neighboring cache, and which ProxySG will provide the fastest response.
Once you have created the ICP or advanced forwarding configuration file, place the file on an FTP or
HTTP server so it can be downloaded to the ProxySG.

Syntax
option 1: icp no path
option 2: icp path url
Table 3.49: #(config) icp
no path
path

136

Negates the path previously set using the command icp
path url.
url

Specifies the network location of the ICP configuration file to
download.

Chapter 3: Privileged Mode Configure Commands

Example
SGOS#(config) icp path 10.25.36.47/files/icpconfig.txt
ok

#(config) identd
IDENTD implements the TCP/IP IDENT user identification protocol. IDENTD operates by looking up
specific TCP/IP connections and returning the user name of the process owning the connection.

Syntax
identd

This changes the prompt to:
SGOS#(config identd)

-subcommandsoption 1: disable
option 2: enable
option 3: exit
option 4: view
Table 3.50: #(config identd)
disable

Disables IDENTD.

enable

Enables IDENTD.

exit

Exits configure identd mode and returns to
configure mode.

view

Displays current IDENTD settings.

Example
SGOS#(config) identd
SGOS#(config identd) enable
ok
SGOS#(config identd) exit
SGOS#(config)

#(config) im
You can configure the IM proxy settings, assign an administrator buddy name for each client type, and
determine how exception messages are sent.

Syntax
option 1: im aol-admin-buddy buddy
option 2: im aol-direct-proxy-host host
option 3: im aol-http-host host
option 4: im aol-native-host host

137

Blue Coat ProxySG Command Line Interface Reference

option 5: im buddy-spoof-message message_text
option 6: im exceptions {in-band | out-of-band}
option 7: im explicit-proxy-vip virtual_ip_address
option 8: im msn-admin-buddy buddy
option 9: im msn-http-host host
option 10: im msn-native-host host
option 11: no
option 12: im yahoo-admin-buddy buddy
option 13: im yahoo-download-host host
option 14: im yahoo-http-host host
option 15: im yahoo-http-chat-host host
option 16: im yahoo-native-host host
option 17: im yahoo-upload-host host
Table 3.51: #(config) im
aol-admin-buddy

buddy

Set AOL admin buddy name.

aol-direct-proxy-host

host

Set AOL direct proxy host.

aol-http-host

host

Set AOL HTTP host.

aol-native-host

host

Set AOL native host.

buddy-spoof-message

message_text

Set buddy spoof message.

exceptions

in-band

Deliver IM exceptions in band.

out-of-band

Deliver IM exceptions out of band.

explicit-proxy-vip

virtual_ip_address

Set explicit proxy virtual IP address.

msn-admin-buddy

buddy

Set MSN admin buddy name.

msn-http-host

host

Set MSN HTTP host.

msn-native-host

host

Set MSN native host.

yahoo-admin-buddy

buddy

Set Yahoo admin buddy name.

yahoo-download-host

host

Set Yahoo download host.

http-host

host

Set Yahoo HTTP host.

http-http-chat-host

host

Set Yahoo HTTP chat host.

yahoo-native-host

host

Set Yahoo native host.

yahoo-upload-host

host

Set Yahoo upload host.

Example
SGOS#(config) im exceptions in-band
ok
SGOS#(config) im yahoo-admin-buddy testname
ok

#(config) inline
See “# inline” on page 27 in Chapter 2: Standard and Privileged Mode Commands.

138

Chapter 3: Privileged Mode Configure Commands

#(config) installed-systems
Use this command to manage the list of installed ProxySG systems.

Syntax
isntalled-systems

This changes the prompt to:
SGOS#(config installed-systems)

-subcommandsoption 1: default system_number
option 2: delete system_number
option 3: exit
option 4: lock system_number
option 5: no {lock system_number | replace}
option 6: replace system_number
option 7: view
Table 3.52: #(config installed-systems)
default

system_number

Sets the default system to the system
indicated by system_number.

delete

system_number

Deletes the system indicated by
system_number.

exit

Exits configure installed-systems mode and
returns to configure mode.

lock

system_number

Locks the system indicated by
system_number.

no

lock system_number

Unlocks the system indicated by
system_number if it is currently locked.

replace

Specifies that the system currently tagged
for replacement should not be replaced. The
default replacement will be used (oldest
unlocked system).

system_number

Specifies that the system identified by
system_number is to be replaced next.

replace
view

Shows installed ProxySG systems.

Example
SGOS#(config) installed-systems
SGOS#(config installed-systems) default 2
ok
SGOS#(config installed-systems) lock 1
ok
SGOS#(config installed-systems) exit
SGOS#(config)

139

Blue Coat ProxySG Command Line Interface Reference

#(config) interface
This command enables you to configure the network interfaces.
The built-in Ethernet adapter is configured for the first time using the setup console. If you want to
modify the built-in adapter configuration, or if you have multiple adapters, you can configure each
one using the command-line interface.

Syntax
interface fast-ethernet interface_number
Table 3.53: #(config) interface
fast-ethernet

interface_number

Sets the number of the fast Ethernet
connection to interface_number. Valid
values for interface_number are 0
through 3, inclusive.

This changes the prompt to:
SGOS#(config interface interface_number)

- subcommandsoption 1: accept-inbound
option 2: exit
option 3: full-duplex
option 4: half-duplex
option 5: ip-address ip_address
option 6: instructions {accelerated-pac | central-pac url | default-pac | proxy}
option 7: link-autosense
option 8: mtu-size mtu_size
option 9: no {accept-inbound | link-autosense}
option 10: speed {10 | 100 | 1gb}
option 11: subnet-mask mask
Table 3.54: #(config interface interface_number)
accept-inbound

Permits inbound connections to this
interface.

exit

Exits configure interface number mode and
returns to configure mode.

full-duplex

Configures this interface for full duplex.

half-duplex
ip-address

140

Configures this interface for half duplex.
ip_address

Sets the IP address for this interface to
ip_address.

Chapter 3: Privileged Mode Configure Commands

Table 3.54: #(config interface interface_number) (Continued)
instructions

accelerated-pac

Configures browser to use your accelerated
pac file.

central-pac url

Configures browser to use your pac file.

default-pac

Configures browser to use a Blue Coat
Systems pac file.

proxy

Configures browser to use a proxy.

link-autosense

Specifies that the interface should
autosense speed and duplex.

mtu-size

mtu_size

no

accept-inbound

Negates the current accept-inbound
settings.

link-autosense

Negates the current link-autosense settings.

speed

10 | 100 | 1gb

Specifies the interface speed.

subnet-mask

subnet_mask

Sets the subnet mask for the interface.

view

Shows the interface settings.

Example
SGOS#(config) interface 0
SGOS#(config interface 0)
ok
SGOS#(config interface 0)
ok
SGOS#(config interface 0)
ok
SGOS#(config interface 0)
SGOS#(config) interface 1
SGOS#(config interface 1)
ok
SGOS#(config interface 1)
ok
SGOS#(config interface 1)
SGOS#(config)

ip-address 10.252.10.54
instructions accelerated-pac
subnet-mask 255.255.255.0
exit
ip-address 10.252.10.72
subnet-mask 255.255.255.0
exit

#(config) ip-default-gateway
A key feature of the ProxySG is the ability to distribute traffic originating at the cache through
multiple IP gateways. Further, you can fine tune how the traffic is distributed among gateways. This
feature works with any routing protocol (for example, static routes or RIP).
Note:

Load balancing through multiple IP gateways is independent from the per-interface load
balancing that the ProxySG automatically does when more than one network interface is
installed.

Syntax
ip-default-gateway ip_address [preference group (1-10)] [weight (1-100)]

141

Blue Coat ProxySG Command Line Interface Reference

Table 3.55: #(config) ip-default-gateway
ip_address

[preference group
(1-10)] [weight
(1-100)]

Specifies the IP address of the default
gateway to be used by the ProxySG.

Example
SGOS#(config) ip-default-gateway 10.25.36.47
ok

#(config) license-key
Use this command to configure license key settings.

Syntax
option 1: license-key auto-update {disable | enable}
option 2: license-key no path
option 3: license-key path url
Table 3.56: #(config) license-key
auto-update

disable | enable

no path
path

Disables or enables auto-update of the Blue
Coat Systems license key.
Negates certain license key settings.

url

Specifies the network path to download
the license key.

Example
SGOS#(config) license-key no path
ok

#(config) line-vty
When you have a CLI session, that session will remain open as long as there is activity. If you leave the
session idle, the connection will eventually timeout and you will have to reconnect. The default
timeout is five minutes. You can set the timeout and other session-specific options using the line-vty
command.

Syntax
line-vty

This changes the prompt to:
SGOS#(config line-vty)

- subcommandsoption 1: exit
option 2: length num_lines_on_screen

142

Chapter 3: Privileged Mode Configure Commands

option 3: no length
option 4: telnet {no transparent | transparent}
option 5: timeout minutes
option 6: view
Table 3.57: #(config) line-vty
exit

Exits configure line-vty mode and returns
to configure mode.
num_lines_on_screen

Specifies the number of lines of code that
should appear on the screen at once.
Specify 0 to scroll without pausing.

no

length

Disables screen paging.

telnet

no transparent |
transparent

Indicates that this is a Telnet
protocol-specific configuration. If you
specify no transparent, carriage returns
are sent to the console as a carriage return
plus linefeed. If you specify transparent,
carriage returns are sent to the console as a
carriage return.

timeout

minutes

Sets the line timeout to the number of
minutes indicated by minutes.

length

view

Displays running system information.

Example
SGOS#(config) line-vty
SGOS#(config line-vty) timeout 60
ok
SGOS#(config line-vty) exit
SGOS#(config)

#(config) load
See “# load” on page 31 in Chapter 2: Standard and Privileged Mode Commands.

#(config) netbios
Use this command to configure NETBIOS.

Syntax
netbios

This changes the prompt to:
SGOS#(config netbios)

option 1: disable
option 2: enable
option 3: exit

143

Blue Coat ProxySG Command Line Interface Reference

option 4: view
Table 3.58: #(config netbios)
disable

Disables NETBIOS services.

enable

Enables NETBIOS services.

exit

Exits configure netbios mode and returns
to configure mode.

view

Shows the NETBIOS settings.

Example
SGOS#(config) netbios
SGOS#(config netbios) enable
ok
SGOS#(config netbios) exit
SGOS#(config)
ok

#(config) no
Use this command to negate the current settings for the archive configuration, content priority, IP
default gateway, SOCKS machine, or system upgrade path.

Syntax
option 1: no archive-configuration
option 2: no bridge bridge_name
option 3: no content {priority {regex regex | url url} | outstanding-requests
{delete | priority | revalidate} regex}
option 4: no ip-default-gateway ip_address
option 5: no serial-number
option 6: no socks-machine-id
option 7: no upgrade-path
Table 3.59: #(config) no
archive-configuration
bridge

bridge_name

Clears the bridge configuration.

content

priority {regex regex |
url url

Removes a deletion regular expression
policy or a deletion URL policy.

outstanding-requests
{delete | priority |
revalidate} regex

Deletes a specific, regular expression
command in-progress (revalidation,
priority, or deletion).

ip_address

Sets the default gateway IP address to zero.

ip-default-gateway
serial-number

144

Clears the archive configuration upload
site.

Removes the serial number.

Chapter 3: Privileged Mode Configure Commands

Table 3.59: #(config) no (Continued)
socks-machine-id

Removes the SOCKS machine ID from the
configuration.

upgrade-path

Clears the upgrade image download path.

Example
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok
SGOS#(config)
ok

no archive-configuration
no content priority regex http://.*cnn.com
no content priority url http://www.bluecoat.com
no ip-default-gateway 10.252.10.50
no socks-machine-id
no upgrade-path

#(config) ntp
Use this command to set NTP parameters. Network Time Protocol (NTP) is a protocol that is used to
synchronize computer clock times in a network of computers. The ProxySG sets the UTC time by
connecting to an NTP server. The ProxySG includes a list of NTP servers available on the Internet. If an
NTP server is not available, you can set the time manually using the Management Console.

Syntax
option 1: ntp clear
option 2: ntp disable
option 3: ntp enable
option 4: ntp interval minutes
option 5: ntp no server domain_name
option 6: ntp server domain_name
Table 3.60: #(config) ntp
clear

Removes all entries from the NTP server
list.

disable

Disables NTP.

enable

Enables NTP.

interval

minutes

Specifies how often to perform NTP server
queries.

no server

domain_name

Removes the NTP server named
domain_name from the NTP server list.

server

domain_name

Adds the NTP server named
domain_name from the NTP server list.

145

Blue Coat ProxySG Command Line Interface Reference

Example
SGOS#(config) ntp server clock.tricity.wsu.edu
ok

#(config) policy
Use this command to specify central and local policy file location, status, and other options.

Syntax
option 1: policy central-path url
option 2: policy forward-path url
option 3: policy local-path url
option 4: policy no
sub-option 1: central-path
sub-option 2: forward-path
sub-option 3: local-path
sub-option 4: notify
sub-option 5: subscribe
sub-option 6: vpm-cpl-path
sub-option 7: vpm-software
sub-option 8: vpm-xml-path

option 5: policy notify
option 6: policy order order of v)pm, l)ocal, c)entral
option 7: policy poll-interval minutes
option 8: policy poll-now
option 9: policy proxy-default {allow | deny}
option 10: policy reset
option 11: policy subscribe
option 12: policy vpm-cpl-path url
option 13: policy vpm-software url
option 14: policy vpm-xml-path url
Table 3.61: #(config) policy

146

central-path

url

Specifies the network path (indicated by
url) from which the central policy file
may be downloaded.

forward-path

url

Specifies the network path (indicated by
url) from which the forward policy file
may be downloaded.

local-path

url

Specifies the network path (indicated by
url) from which the local policy file may
be downloaded.

Chapter 3: Privileged Mode Configure Commands

Table 3.61: #(config) policy (Continued)
vpm-cpl-path

url

Specifies the network path (indicated by
url) from which the vpm-cpl policy file
may be downloaded.

vpm-xml-path

url

Specifies the network path (indicated by
url) from which the vpm-xml policy file
may be downloaded.

no

central-path

Specifies that the current central policy file
URL setting should be cleared.

forward-path

Specifies that the current forward policy
file URL setting should be cleared.

local-path

Specifies that the current local policy file
URL setting should be cleared.

notify

Specifies that no email notification should
be sent if the central policy file should
change.

subscribe

Specifies that the current policy should not
be automatically updated in the event of a
central policy change.

vpm-cpl-path

Clears the network path to download VPM
CPL policy.

vpm-software

Clears the network path to download VPM
software.

vpm-xml-path

Clears the network path to download VPM
XML policy.

notify

Specifies that an email notification should
be sent if the central policy file should
change.

order

order of v)pm, l)ocal,
c)entral

Specifies the policy evaluation order.

poll-interval

minutes

Specifies the number of minutes that
should pass between tests for central
policy file changes.

poll-now
proxy-default

Tests for central policy file changes
immediately.
allow

The default proxy policy is allow.

deny

The default proxy policy is deny.

reset

Clears all policies.

subscribe

Indicates that the current policy should be
automatically updated in the event of a
central policy change.

vpm-software

url

Specifies the network path to download
the VPM software.

Example
SGOS#(config) policy local-path http://www.server1.com/local.txt
ok
SGOS#(config) policy central-path http://www.server2.com/central.txt

147

Blue Coat ProxySG Command Line Interface Reference

ok
SGOS#(config) policy poll-interval 10
ok

#(config) profile
Sets your system profile to normal (the default setting) or portal (to accelerate the server).

Syntax
option 1: profile bwgain
option 2: profile normal
option 3: profile portal
Table 3.62: #(config) profile
bwgain

Sets your system profile to bandwidth
gain.

normal

Sets your system profile to normal.

portal

Sets your system profile to portal.

Example
SGOS#(config) profile normal
ok

#(config) restart
Use this command to set restart options for the ProxySG.

Syntax
option 1: restart core-image {context | full | keep number | none}
option 2: restart mode {hardware | software}
Table 3.63: #(config) restart
core-image

mode

148

context

Indicates only core image context should
be written on restart.

full

Indicates full core image should be written
on restart.

keep number

Specifies a number of core images to keep
on restart.

none

Indicates no core image should be written
on restart.

hardware

Specifies a hardware restart.

software

Specifies a software restart.

Chapter 3: Privileged Mode Configure Commands

Example
SGOS#(config) restart mode software
ok

#(config) return-to-sender
The return-to-sender feature eliminates unnecessary network traffic when the three following
conditions are met:


The ProxySG has connections to clients or servers on a different subnet.



The shortest route to the clients or servers is not through the default gateway.



There are no static routes or RIP routes defined that apply to the IP addresses of the clients and
servers.

Under these conditions, if the return-to-sender feature is enabled, the ProxySG remembers the MAC
address of the last hop for a packet from the client or server and sends any responses or requests to the
MAC address instead of the default gateway.
Under the same conditions, if return-to-sender is disabled, the ProxySG sends requests or responses to
the default gateway, which then sends the packets to the gateway representing the last hop to the
ProxySG for the associated connection. This effectively doubles the number of packets transmitted on
the LAN compared to when return-to-sender is enabled.
Inbound return-to-sender affects connections initiated to the ProxySG by clients. Outbound
return-to-sender affects connections initiated by the ProxySG to origin servers.
Note:

Return-to-sender functionality should only be used if static routes cannot be defined for the
clients and servers or if routing information for the clients and servers is not available through
RIP packets.

Syntax
option 1: return-to-sender inbound {disable | enable}
option 2: return-to-sender outbound {disable | enable}
option 3: return-to-sender version {1 | 2}
Table 3.64: #(config) return-to-sender
inbound

disable | enable

Enables or disables return-to-sender for
inbound sessions.

149

Blue Coat ProxySG Command Line Interface Reference

Table 3.64: #(config) return-to-sender (Continued)
outbound

disable | enable

Enables or disables return-to-sender for
outbound sessions.

version

1 | 2

Enables return-to-sender(RTS) versions 1
or 2. In version 1, the RTS route is created
at Layer-3 and stored globally, thus being
interface agnostic.
RTS version 2 was introduced to get
around this multi-interface limitation. With
version 2, TCP now stores a per-socket RTS
route that contains both the destination
MAC address and interface information.
Once the SYN is received by the ProxySG
all subsequent packets on that socket will
traverse the interface on which the SYN
was received.
Note that if you are using version 2 and an
interface goes down, all current sockets
tied to that interface will time out.
However, subsequent and existing TCP
connections continue to function normally
on the other interfaces.

Example
SGOS#(config) return-to-sender inbound enable
ok

#(config) reveal-advanced
See “# reveal-advanced” on page 40 in Chapter 2: Standard and Privileged Mode Commands.

#(config) rip
Use this command to set RIP (Routing Information Protocol) configuration options.
Using RIP, a host and router can send a routing table list of all other known hosts to its closest
neighbor host every 30 seconds. The neighbor host passes this information on to its next closest
neighbor and so on until all hosts have perfect knowledge of each other. (RIP uses the hop count
measurement to derive network distance.) Each host in the network can then use the routing table
information to determine the most efficient route for a packet.
The RIP configuration is defined in a configuration file. To configure RIP, first create a text file of RIP
commands and then load the file by using the load command.

Syntax
option 1: rip disable
option 2: rip enable
option 3: rip no path

150

Chapter 3: Privileged Mode Configure Commands

option 4: rip path url
Table 3.65: #(config) rip
disable

Disables the current RIP configuration.

enable

Enables the current RIP configuration.

no path

Clears the current RIP configuration path
as determined using the rip path url
command.

path

url

Sets the path to the RIP configuration file
to the URL indicated by url.

Example
SGOS#(config) rip path 10.25.36.47/files/rip.txt
ok

#(config) security
The ProxySG provides the ability to authenticate and authorize explicit and transparent proxy users
using industry-standard authentication services. The supported authentication services are:


Certificate – Authentication using X.509 Certificates



LDAP – Lightweight Directory Access Protocol



Local – Users and groups stored locally on the ProxySG



NTLM – Windows NT Challenge Response



RADIUS – Remote Authentication for Dialup Users

The ProxySG provides a flexible authentication architecture that supports multiple services (LDAP,
NTLM, and the like) with multiple backend servers (for example, LDAP directory servers together
with NT domains with no trust relationship, and so forth) within each authentication scheme with the
introduction of the realm.
A realm authenticates and authorizes users for access to Blue Coat Systems ProxySG services using
either explicit proxy or transparent proxy mode. Note that multiple authentication realms can be used
on a single ProxySG. Multiple realms are essential if the enterprise is a Managed Service provider, or
the company has merged with or acquired another company, for example. Even for companies using
only one protocol, multiple realms may be necessary—as in the case of a company using an LDAP
server with multiple authentication boundaries. You can use realm sequencing to search the multiple
realms all at once.
A realm configuration includes:


realm name



authentication service—(including LDAP, Local, NTLM, RADIUS, Certificate).



external server configuration—backend server configuration information, such as host, port, and
other relevant information based on the selected service.



authentication schema—the definition used to authenticate users.

151

Blue Coat ProxySG Command Line Interface Reference



authorization schema—the definition used to (1) authorize users for membership in defined
groups, and (2) check for attributes that trigger evaluation against any defined policy rules.

For details, refer to the Using Authentication Services chapter of the Blue Coat Configuration and
Management Guide.

Syntax
option 1: security allowed-access {add | remove} source_ip [ip_mask]
option 2: security authentication-form
sub-option 1: create form_name
sub-option 2: delete form_name
sub-option 3: inline form_name eof_marker
sub-option 4: load form_name
sub-option 5: no path form_name
sub-option 6: path [form_name] path

option 3: security certificate
sub-option 1: create-realm realm_name
sub-option 2: delete-realm realm_name
sub-option 3: edit-realm realm_name—changes the prompt (see “#(config) security
certificate edit-realm realm_name” on page 158)
sub-option 4: view [realm_name]

option 4: security default-authenticate-mode {auto | sg2}
option 5: security destroy-old-password [force]
option 6: security enable-password password
option 7: security enforce-acl {disable | enable}
option 8: security flush-credentials
sub-option 1: [on-policy-change {disable | enable}]
sub-option 2: [realm realm]

option 9: front-panel-pin PIN
option 10: security hashed-enable-password hashed_password
option 11: security hashed-password hashed_password
option 12: security ldap
sub-option 1: create-realm {ad | iplanet | nds | other} realm_name [base_dn]
primary_host [primary_port]
sub-option 2: delete-realm realm_name
sub-option 3: edit-realm realm_name—changes the prompt (see “#(config) security ldap
edit-realm realm_name” on page 160)
sub-option 4: view [realm_name]

option 13: security local
sub-option 1: create-realm realm_name
sub-option 2: delete-realm realm_name

152

Chapter 3: Privileged Mode Configure Commands

sub-option 3: edit-realm realm_name—changes the prompt (see “#(config) security local
edit-realm realm_name” on page 163)
sub-option 4: view [realm_name]

option 14: security local-user-list
sub-option 1: clear [force]
sub-option 2: create local_user_list
sub-option 3: default {append-to-default {disable | enable} | list
local_user_list}
sub-option 4: delete local_user_list [force]
sub-option 5: edit local_user_list—changes the prompt (see “#(config) security
local-user-list edit local_user_list” on page 164)

option 15: security management
sub-option 1: auto-logout-timeout seconds
sub-option 2: display-realm name
sub-option 3: no {auto-logout-timeout | display-realm}

option 16: security ntlm
sub-option 1: create-realm realm_name primary_server_host [primary_server_port]
sub-option 2: delete-realm realm_name
sub-option 3: edit-realm realm_name—changes the prompt (see “#(config) security ntlm
edit-realm realm_name” on page 167)
sub-option 4: view [realm_name]

option 17: security password password
option 18: security password-display {encrypted | keyring keyring | none | view}
option 19: security radius
sub-option 1: create-realm realm_name secret primary_server_host
[primary_server_port]
sub-option 2: create-realm-encrypted realm_name encrypted-secret
primary_server_host [primary_server_port]
sub-option 3: delete-realm realm_name
sub-option 4: edit-realm realm_name—changes the prompt (see “#(config) security radius
edit-realm realm_name” on page 168)
sub-option 5: view [realm_name]

option 20: security request-storage
sub-option 1: allow-redirects {disable | enable}
sub-option 2: expiry-time seconds
sub-option 3: max-size megabytes
sub-option 4: verify-ip {disable | enable}

option 21: security sequence
sub-option 1: create-realm realm_sequence_name
sub-option 2: delete-realm realm_sequence_name

153

Blue Coat ProxySG Command Line Interface Reference

sub-option 3: edit-realm realm_sequence_name—changes the prompt (see “#(config)
security sequence edit-realm realm_sequence_name” on page 170)
sub-option 4: view [realm_sequence_name]

option 22: security siteminder
sub-option 1: create-realm realm_name
sub-option 2: delete-realm realm_name
sub-option 3: edit-realm realm_name—changes the prompt (see “#(config) security
siteminder edit-realm realm_name” on page 171)
sub-option 4: view [realm_name]

option 23: security transparent-proxy-auth
sub-option 1: cookie {persistent | session}
sub-option 2: method {ip | cookie}
sub-option 3: time-to-live {ip | persistent-cookie} minutes
sub-option 4: virtual-url url

option 24: security username user_name
Table 3.66: #(config) security
allowed-access

authentication-form

certificate

default-authenticatemode

154

add source_ip [ip_mask]

Adds the specified IP to the access control
list.

remove source_ip
[ip_mask]

Removes the specified IP from the access
control list.

create form_name

Creates a new authentication form.

delete form_name

Deletes an authentication form.

inline form_name
eof_marker

Installs an authentication form from
console input.

load form_name

Downloads a new authentication form.

no path [form_name]

Negates authentication-form
configuration.

path [form_name] path

Specifies the path (URL or IP address) from
which to load an authentication form, or
the entire set of authentication forms.

create-realm realm_name

Creates a new certificate realm with the
name specified. The maximum number of
certificate realms is 40.

delete-realm realm_name

Deletes the specified certificate realm.

edit-realm realm_name

Changes the prompt. See “#(config)
security certificate edit-realm
realm_name” on page 158.

view [realm_name]

Displays the configuration of all certificate
realms or just the configuration for
realm_name if specified.

auto

Sets the default authenticate.mode to
auto.

sg2

Sets the default authenticate.mode to
sg2.

Chapter 3: Privileged Mode Configure Commands

Table 3.66: #(config) security (Continued)
destroy-old-passwords

[force]

Destroys recoverable passwords in
configuration used by previous versions.
Do not use this command if you intend to
downgrade as the old passwords will be
destroyed. Specify “force” to destroy the
passwords without a prompt for
confirmation.

enable-password

“password”

Sets the console enable password to the
password specified. This is the password
required to enter enable mode from the
CLI when using console credentials, the
serial console or RSA SSH.

enforce-acl

disable

Disables the console access control list.

enable

Enables the console access control list.

[on-policy-change
{disable | enable}]

Disables/enables the flushing of the
credential cache when policy is compiled.

[realm realm]

Flushes the credentials for a particular
realm now.

front-panel-pin

PIN

Sets a four-digit PIN to restrict access to the
front panel of the ProxySG. To clear the
PIN, specify 0000 instead of a real PIN.

hashed-enable-password

hashed_password

Specifies the console enable password in
hashed format.

hashed-password

hashed_password

Specifies the console password in hashed
format.

ldap

create-realm {ad |
iplanet | nds | other}
realm_name [base_DN]
primary_host
[primary_port]

Creates a new LDAP realm of the type
specified with the name, base DN, primary
host and port specified. The base DN and
port are optional. A base DN must be
defined for LDAP authentication to
succeed. The maximum number of LDAP
realms is 40.

delete-realm realm_name

Deletes the specified LDAP realm.

edit-realm

Changes the prompt. See “#(config)
security ldap edit-realm
realm_name” on page 160.

view [realm_name]

Displays the configuration of all LDAP
realms or just the configuration for
realm_name if specified.

flush-credentials

155

Blue Coat ProxySG Command Line Interface Reference

Table 3.66: #(config) security (Continued)
local

local-user-list

management

156

create-realm realm_name

Creates a new local realm with the name
specified. The maximum number of local
realms is 40.

delete-realm realm_name

Deletes the specified local realm.

edit-realm

Changes the prompt. See “#(config)
security local edit-realm
realm_name” on page 163.

view [realm_name]

Displays the configuration of all local
realms or just the configuration for
realm_name if specified.

clear [force]

Clears all local user lists. Lists referenced
by local realms and the default local user
list will be recreated but empty. Specify
“force” to clear realms without a prompt
for confirmation.

create local_user_list

Creates the local user list with the name
specified.

default
append-to-default
{disable | enable}

Disables/enables appending uploaded
users to the default local user list.

default list
local_user_list

Specifies the default local user list. The
default list is populated during password
file uploads. The default list is also the
default list used by local realms when they
are created.

delete local_user_list
[force]

Deletes the specified local user list. The
default list and any lists used by local
realms cannot be deleted. Specify “force”
to delete the list without a prompt for
confirmation.

edit

Changes the prompt. See “#(config)
security local-user-list edit
local_user_list” on page 164.

auto-logout-timeout
seconds

Specifies the length of a management
console session before the administrator is
required to re-enter credentials. The
default is 900 seconds (15 minutes).

display-realm name

Specifies the realm to display in the
management console challenge. The
default value is the IP of the ProxySG.

no auto-logout-timeout

Disables the automatic session logout.

no display-realm

Resets the display realm to be the IP of the
ProxySG.

Chapter 3: Privileged Mode Configure Commands

Table 3.66: #(config) security (Continued)
ntlm

create-realm realm_name
primary_server_host
[primary_server_port]

Creates a new NTLM realm with the name,
primary server host and port specified. The
maximum number of NTLM realms is 40.

delete-realm realm_name

Deletes the specified NTLM realm.

edit-realm

Changes the prompt. See “#(config)
security ntlm edit-realm
realm_name” on page 167.

view [realm_name]

Displays the configuration of all NTLM
realms or just the configuration for
realm_name if specified.

password

“password”

Specifies the console password.

password-display

encrypted | none

Specifies format to display passwords in
“show config” output. Specify “encrypted”
to display encrypted passwords. Specify
“none” to display no passwords.

keyring

Specifies the keyring to use for password
encryption.

view

Displays the current password display
settings.

create-realm realm_name
secret
primary_server_host
[primary_server_port]

Creates a new RADIUS realm with the
name, secret, primary server host and port
specified. Only 1 RADIUS realm can be
created.

create-realm-encrypted
realm_name
encrypted-secret
primary_server_host
[primary_server_port]

Creates a new RADIUS realm with the
name, secret (in encrypted format),
primary server host and port specified.
Only 1 RADIUS realm can be created.

delete-realm realm_name

Deletes the specified RADIUS realm.

edit-realm

Changes the prompt. See “#(config)
security radius edit-realm
realm_name” on page 168.

view [realm_name]

Displays the configuration of all RADIUS
realms or just the configuration for
realm_name if specified.

allow-redirects
{disable | enable}

Sets whether to allow stored request to be
redirected.

expiry-time seconds

Sets the expiry time of stored requests
requiring authentication.

max-size megabytes

Sets the maximum size of a stored request
requiring authentication.

verify-ip {disable |
enable}

Sets whether to compare the client IP with
the IP in the stored request.

radius

request-storage

157

Blue Coat ProxySG Command Line Interface Reference

Table 3.66: #(config) security (Continued)
sequence

siteminder

transparent-proxy-auth

username

create-realm
realm_sequence_name

Creates a new realm sequence with the
name specified. The maximum number of
realm sequences is 40.

delete-realm
realm_sequence_name

Deletes the specified realm sequence.

edit-realm
realm_sequence_name

Changes the prompt. See “#(config)
security sequence edit-realm
realm_sequence_name” on page 170.

view [realm_name]

Displays the configuration of all realm
sequences or just the configuration for
realm_name if specified.

create-realm
realm_siteminder_name

Creates a new SiteMinder realm with the
name specified. The maximum number of
SiteMinder realms is 40.

delete-realm
realm_sequence_name

Deletes the specified SiteMinder realm.

edit-realm
realm_sequence_name

Changes the prompt. See “#(config)
security siteminder edit-realm
realm_name” on page 171.

view [realm_name]

Displays the configuration of all
SiteMinder realms or just the configuration
for realm_name if specified.

cookie {persistent |
session}

Specifies whether to use persistent or
session cookies.

method {ip | cookie}

Specifies whether to use IP or cookie
surrogate credentials.

time-to-live {ip |
persistent-cookie}
minutes

Specifies the length of time that the
surrogate credentials are considered valid.

virtual-url url

Specifies the virtual URL that requests
requiring authentication will be redirected
to.

username

Specifies the console account username.

Example
SGOS#(config) security local create-realm testlocal
ok
SGOS#(config) security allowed-access add 10.253.101.23 255.255.255.255
ok
SGOS#(config) security enable-password enable
ok

#(config) security certificate edit-realm realm_name
Syntax
security certificate edit-realm realm_name

158

Chapter 3: Privileged Mode Configure Commands

This changes the prompt to:
SGOS#(config certificate realm_name)

- subcommandsoption 1: authorization
sub-option 1: append-base-dn {disable | dn dn_to_append | enable}
sub-option 2: containter-attr-list list_of_attribute_names
sub-option 3: no {container-attr-list | realm-name}
sub-option 4: realm-name authorization_realm_name
sub-option 5: username-attribute username_attribute

option 2: cache-duration seconds
option 3: display-name display_name
option 4: exit
option 5: rename new_realm_name
option 6: view
option 7: virtual-url url
Table 3.67: #(config certificate realm_name)
authorization

append-base-dn {disable
| dn DN_to_append |
enable}

Disables or enables appending of the base
DN to the authenticated username, or
specifies the base DN to append. If no base
DN is specified, then the first base DN in
the LDAP authorization realm will be
used. Applies to LDAP authorization
realms only.

container-attr-list
list_of_attribute_names

Specifies the attributes from the certificate
subject to use in constructing the user DN.
E.g. “o, ou”. The list needs to be quoted if
it contains spaces.

no {container-attr-list
| realm-name}

Clears the container attribute list or the
authorization realm.

realm-name
authorization_realm_nam
e

Specifies the authorization realm to use.
Only LDAP and local realms are valid
authorization realms.

username-attribute
username_attribute

Specifies the attribute in the certificate
subject that identifies the user’s relative
name. The default is “cn”.

cache-duration

seconds

Specifies the length of time to cache
credentials for this realm.

display-name

display-name

Specifies the display name for this realm.

exit
rename

Exits configure security certificate mode
and returns to configure mode.
new_realm_name

Renames this realm to new_realm_name.

159

Blue Coat ProxySG Command Line Interface Reference

Table 3.67: #(config certificate realm_name) (Continued)
view
virtual-url

Displays this realm’s configuration.
url

Specifies the virtual URL to use for this
realm. If no URL is specified the global
transparent proxy virtual URL is used.

Example
SGOS#(config) security certificate
SGOS#(config certificate testcert)
ok
SGOS#(config certificate testcert)
ok
SGOS#(config certificate testcert)
SGOS#(config)

edit-realm testcert
no container-attr-list
cache-duration 800
exit

#(config) security ldap edit-realm realm_name
Syntax
security ldap edit-realm realm_name

This changes the prompt to:
SGOS#(config ldap realm_name)

- subcommandsoption 1: alternate-server host [port]
option 2: cache-duration seconds
option 3: case-sensitive {disable | enable}
option 4: display-name display_name
option 5: distinguished-name
sub-option 1: user-attribute-type user_attribute_type
sub-option 2: base-dn {add | demote | promote | remove} base_dn | clear

option 6: exit
option 7: membership-attribute attribute_name
option 8: membership-type {group | user}
option 9: membership-username (full | relative)
option 10: no {alternate-server | membership-attribute}
option 11: objectclass
sub-option 1: container {add | remove} container_objectclass | clear
sub-option 2: group {add | remove} group_objectclass | clear
sub-option 3: user {add | remove} user_objectclass | clear

option 12: primary-server host [port]
option 13: protocol-version {2 | 3}
option 14: referrals-follow {disable | enable}

160

Chapter 3: Privileged Mode Configure Commands

option 15: rename new_realm_name
option 16: search
sub-option 1: anonymous {disable | enable}
sub-option 2: dereference {always | finding | never | searching}
sub-option 3: encrypted-password encrypted_password
sub-option 4: password password
sub-option 5: user-dn user_dn

option 17: server-type {ad | iplanet | nds | other}
option 18: spoof-authentication {none | origin | proxy}
option 19: ssl {disable | enable}
option 20: ssl-verify-server {disable | enable}
option 21: timeout seconds
option 22: view
option 23: virtual-url url
Table 3.68: #(config ldap realm_name)
alternate-server

host [port]

Specifies the alternate server host and port.

cache-duration

seconds

Specifies the length of time to cache
credentials for this realm.

case-sensitive

disable | enable

Specifies whether or not the LDAP server
is case-sensitive.

display-name

display-name

Specifies the display name for this realm.

distinguished-name

user-attribute-type
user_attribute_type

Specifies the attribute type that defines the
relative user name.

base-dn {add | demote |
promote | remove}
base_dn

Adds/demotes/promotes/
removes a base DN from the base DN list,
or clears the base DN list.

exit

Exits configure security ldap mode and
returns to configure mode.

membership-attribute

attribute_name

Specifies the attribute that defines group
membership.

membership-type

group | user

Specifies the membership type. Specify
group if user memberships are specified in
groups. Specify user if memberships are
specified in users.

membership-username

full | relative

Specifies the username type to use during
membership lookups. The full option
specifies that the user's FQDN will be used
during membership lookups, and
relative option specifies that the user's
relative username will be used during
membership lookups. Only one can be
selected at a time.

no

alternate-server |
membership-attribute

Clears the alternate-server or
membership-attribute values.

161

Blue Coat ProxySG Command Line Interface Reference

Table 3.68: #(config ldap realm_name) (Continued)
objectclass

container {add |
remove}
container_objectclass |
clear

Adds/removes container objectclass
values from the list (these values are used
during VPM searches of the LDAP realm),
or clears all values from the container
objectclass list.

group {add | remove}
group_objectclass |
clear

Adds/removes group objectclass values
from the list (these values are used during
VPM searches of the LDAP realm), or
clears all values from the group objectclass
list.

user {add | remove}
user_objectclass |
clear

Adds/removes user objectclass values
from the list (these values are used during
VPM searches of the LDAP realm), or
clears all values from the user objectclass
list.

primary-server

host [port]

Specifies the primary server host and port.

protocol-version

2 | 3

Specifies the LDAP version to use. SSL
and referral processing are not available in
LDAP v2.

referrals-follow

disable | enable

Disables/enables referral processing. This
is available in LDAP v3 only.

rename

new_realm_name

Renames this realm to new_realm_name.

search

anonymous disable |
enable

Disables/enables anonymous searches.

dereference {always |
finding | never |
searching}

Specifies the dereference level. Specify
always to always dereference aliases.
Specify finding to dereference aliases only
while locating the base of the search.
Specify searching to dereference aliases
only after locating the base of the search.
Specify never to never dereference aliases.

encrypted-password
encrypted_password

Specifies the password to bind with during
searches in encrypted format.

password password

Specifies the password to bind with during
searches.

user-dn user_dn

Specifies the user DN to bind with during
searches.

server-type

162

{ad | iplanet |
other}

nds |

Specifies the LDAP server type for this
realm.

Chapter 3: Privileged Mode Configure Commands

Table 3.68: #(config ldap realm_name) (Continued)
spoof-authentication

none | origin | proxy

Enables/disables the forwarding of
authenticated credentials to the origin
content server or for proxy authentication.
You can only choose one.
• If set to origin, the spoofed header will
be an Authorization: header.
• If set to proxy, the spoofed header will be
a Proxy-Authorization: header.
• If set to none, no spoofing will be done.
Flush the entries for a realm if the
spoof-authentication value is changed to
ensure that the spoof-authentication value
is immediately applied.

ssl

disable | enable

Disables/enables SSL communication
between the ProxySG and the LDAP
server. This is only available in LDAP v3.

ssl-verify-server

disable | enable

Specifies whether or not to verify the
LDAP server’s certificate.

timeout

seconds

Specifies the LDAP server’s timeout.

view
virtual-url

Displays this realm’s configuration.
url

Specifies the virtual URL to use for this
realm. If no URL is specified the global
transparent proxy virtual URL is used.

Example
SGOS#(config) security ldap
SGOS#(config ldap testldap)
ok
SGOS#(config ldap testldap)
ok
SGOS#(config ldap testldap)
SGOS#(config)

edit-realm testldap
server-type iplanet
spoof-authentication origin
exit

#(config) security local edit-realm realm_name
Syntax
security local edit-realm realm_name

This changes the prompt to:
SGOS#(config local realm_name)

- subcommandsoption 1: cache-duration seconds
option 2: display-name display_name
option 3: exit
option 4: local-user-list local_user_list_name

163

Blue Coat ProxySG Command Line Interface Reference

option 5: rename new_realm_name
option 6: spoof-authentication {none | origin | proxy}
option 7: view
option 8: virtual-url url
Table 3.69: #(config local realm_name)
cache-duration

seconds

Specifies the length of time to cache
credentials for this realm.

display-name

display_name

Specifies the display name for this realm.

exit
local-user-list

Exits configure security local mode and
returns to configure mode.
local_user_list_name

Specifies the local user list to for this
realm.

rename

new_realm_name

Renames this realm to new_realm_name.

spoof-authentication

disable | enable

Enables/disables the forwarding of
authenticated credentials to the origin
content server or for proxy authentication.
You can only choose one.
• If set to origin, the spoofed header will
be an Authorization: header.
• If set to proxy, the spoofed header will
be a Proxy-Authorization: header.
• If set to none, no spoofing will be done.
Flush the entries for a realm if the
spoof-authentication value is changed to
ensure that the spoof-authentication value
is immediately applied.

view
virtual-url

Displays this realm’s configuration.
url

Specifies the virtual URL to use for this
realm. If no URL is specified the global
transparent proxy virtual URL is used.

Example
SGOS#(config) security local edit-realm testlocal
SGOS#(config local testlocal) cache-duration 1500
ok
SGOS#(config local testlocal) spoof-authentication proxy
ok
SGOS#(config local testlocal) exit
SGOS#(config)

#(config) security local-user-list edit local_user_list
Syntax
security local-user-list edit local_user_list

This changes the prompt to:

164

Chapter 3: Privileged Mode Configure Commands

SGOS#(config local-user-list local_user_list)

- subcommandsoption 1: disable-all
option 2: enable-all
option 3: exit
option 4: group
sub-option 1: clear
sub-option 1: create group_name
sub-option 2: delete group_name [force]

option 5: lockout-duration seconds
option 6: max-failed-attempts attempts
option 7: no [lockout-duration | max-failed-attempts | reset-interval]
option 8: reset-interval seconds
option 9: user
sub-option 1: clear
sub-option 2: create user_name
sub-option 3: delete user_name [force]
sub-option 4: edit user_name—changes the prompt to #SGOS(config local-user-list
local_user_list user_name)
disable | enable
exit
group {add | remove} group_name
hashed-password hashed_password
password password
view
sub-option 5: view
Table 3.70: #(config local-user-list local_user_list)
disable-all

Disables all user accounts in the
specified list

enable-all

Enables all user accounts in the specified
list.

exit

Exits configure local-user-list mode and
returns to configure mode.

group

clear

Clears all groups from the list. The users
remain but do not belong to any groups.

create group_name

Creates the specified group in the local
user list.

delete group_name

Deletes the specified group in the local
user list.

165

Blue Coat ProxySG Command Line Interface Reference

Table 3.70: #(config local-user-list local_user_list) (Continued)
lockout-duration

seconds

The length of time a user account is
locked out after too many failed
password attempts. The default is 3600.

max-failed-attempts

attempts

The number of failed attempts to login to
a ProxySG before the user account is
locked. The default is 60 attempts.

no

lockout-duration |
max-failed-attempts |
reset-interval

Disables the settings for this user list.

reset-interval

seconds

The length of seconds to wait after the
last failed attempt before resetting the
failed counter to zero.

user

clear

Clears all users from the list The groups
remain but do not have any users.

create user_name

Creates the specified user in the local
user list.

delete user_name

Deletes the specified user in the local
user list.

edit user_name

Edits the specified user in the local user
list. Changes the prompt to #(config
local-user-list
local_user_list user_name).

disable | enable

exit

Exits configure local-user-list
user_list mode and returns to
configure local-user-list mode.

group add | remove
group_name

Adds/removes the specified group
from the user.

hashed-password
hashed_password

Specifies the user’s password in
hashed format.

password password

Specifies the user’s password.

view
view

Disables/enables the user account.

Displays the user account.
Displays all users and groups in the local
user list.

Example
SGOS#(config) security local-user-list edit testlul
SGOS#(config local-user-list testlul) user create testuser
ok
SGOS#(config local-user-list testlul) user edit testuser

166

Chapter 3: Privileged Mode Configure Commands

SGOS#(config local-user-list testlul testuser) enable
ok
SGOS#(config local-user-list testlul testuser) exit
SGOS#(config local-user-list testlul) exit
SGOS#(config)

#(config) security ntlm edit-realm realm_name
Edits the NTLM realm specified by realm_name.

Syntax
security ntlm edit-realm realm_name

This changes the prompt to:
SGOS#(config ntlm realm_name)

- subcommandsoption 1: alternate-server host [port]
option 2: cache-duration seconds
option 3: credentials-basic {disable | enable}
option 4: credentials-ntlm {disable | enable}
option 5: display-name display_name
option 6: exit
option 7: no alternate-server
option 8: primary-server host [port]
option 9: rename new_realm_name
option 10: timeout seconds
option 11: ssl {disable | enable}
option 12: ssl-verify-server {disable | enable}
option 13: view
option 14: virtual-url url
Table 3.71: #(config ntlm realm_name)
alternate-server

host [port]

Specifies the alternate server host and
port.

cache-duration

seconds

Specifies the length of time to cache
credentials for this realm.

credentials-basic

disable | enable

Disables/enables support for Basic
credentials in this realm. At least one of
Basic or NTLM credentials must be
supported.

credentials-ntlm

disable | enable

Disables/enables support for NTLM
credentials in this realm. At least one of
Basic or NTLM credentials must be
supported.

167

Blue Coat ProxySG Command Line Interface Reference

Table 3.71: #(config ntlm realm_name) (Continued)
display-name

display_name

Exits configure ntlm-realm mode and
returns to configure mode.

no alternate-server

Clears the alternate-server.

primary-server

host [port]

Specifies the primary server host and
port.

rename

new_realm_name

Renames this realm to
new_realm_name.

timeout

seconds

Specifies the NTLM request timeout.

ssl

disable | enable

Disables/enables SSL communication
between the ProxySG and BCAAA.

ssl-verify-server

disable | enable

Specifies whether or not to verify the
BCAAA certificate.

view
virtual-url

Displays this realm’s configuration.
url

Specifies the virtual URL to use for this
realm. If no URL is specified the global
transparent proxy virtual URL is used.

Example
SGOS#(config) security ntlm
SGOS#(config ntlm testntlm)
ok
SGOS#(config ntlm testntlm)
ok
SGOS#(config ntlm testntlm)
SGOS#(config)

edit-realm testntlm
cache-duration 1500
no alternate server
exit

#(config) security radius edit-realm realm_name
Edits the RADIUS realm specified by realm_name.

Syntax
security radius edit-realm realm_name

This changes the prompt to:
SGOS#(config radius realm_name)

option 1: alternate-server
sub-option 1: encrypted-secret encrypted_secret
sub-option 2: host [port]
sub-option 3: secret secret
sub-option 4: service-type type

option 2: cache-duration seconds
option 3: case-sensitive {disable | enable}
option 4: display-name display_name

168

Specifies the display name for this realm.

exit

Chapter 3: Privileged Mode Configure Commands

option 5: exit
option 6: no alternate-server
option 7: primary-server
sub-option 1: encrypted-secret encrypted_secret
sub-option 2: host [port]
sub-option 3: secret secret
sub-option 4: service-type type

option 8: rename new_realm_name
option 9: timeout seconds
option 10: server-retry count
option 11: spoof-authentication {none | origin | proxy}
option 12: view
option 13: virtual-url url
Table 3.72: #(config radius realm_name)
alternate-server

host [port]

Specifies the alternate server host and
port.

encrypted-secret
encrypted_secret

Specifies the alternate server secret in
encrypted format.

secret secret

Specifies the alternate server secret.

service-type type

Specifies the service-type to send to the
alternate server.

cache-duration

seconds

Specifies the length of time to cache
credentials for this realm.

case-sensitive

disable | enable

Specifies whether or not the RADIUS
server is case-sensitive.

display-name

display_name

Specifies the display name for this realm.

exit

Exits configure radius-realm mode and
returns to configure mode.

no alternate-server
primary-server

Clears the alternate-server.
host [port]

Specifies the primary server host and
port.

encrypted-secret
encrypted_secret

Specifies the primary server secret in
encrypted format.

secret secret

Specifies the primary server secret.

service-type type

Specifies the service-type to send to the
primary server.

rename

new_realm_name

Renames this realm to
new_realm_name.

timeout

seconds

Specifies the RADIUS request timeout.

server-retry

count

Specifies the number of authentication
retry attempts.

169

Blue Coat ProxySG Command Line Interface Reference

Table 3.72: #(config radius realm_name) (Continued)
spoof-authentication

none | origin | proxy

Enables/disables the forwarding of
authenticated credentials to the origin
content server or for proxy
authentication. You can only choose one.
• If set to origin, the spoofed header will
be an Authorization: header.
• If set to proxy, the spoofed header will
be a Proxy-Authorization: header.
• If set to none, no spoofing will be
done.
Flush the entries for a realm if the
spoof-authentication value is changed to
ensure that the spoof-authentication
value is immediately applied.

view
virtual-url

Displays this realm’s configuration.
url

Specifies the virtual URL to use for this
realm. If no URL is specified the global
transparent proxy virtual URL is used.

Example
SGOS#(config) security radius edit-realm testradius
SGOS#(config radius testradius) server-retry 8
ok
SGOS#(config radius testradius) spoof-authentication proxy
ok
SGOS#(config radius testradius) exit
SGOS#(config)

#(config) security sequence edit-realm realm_sequence_name
Edits the realm sequence specified by realm_sequence_name.

Syntax
security sequence edit-realm realm_sequence_name

This changes the prompt to:
SGOS#(config sequence realm_sequence_name)

option 1: display-name display_name
option 2: exit
option 3: ntlm-only-once {disable | enable}
option 4: realm {add | demote | promote | remove} realm_name | clear
option 5: rename new_realm_name
option 6: view
option 7: virtual-url url

170

Chapter 3: Privileged Mode Configure Commands

Table 3.73: #(config sequence realm_sequence_name)
display-name

display_name

exit

Specifies the display name for this realm.
Exits configure sequence-realm mode
and returns to configure mode.

ntlm-only-once

disable | enable

Specifies whether or not to challenge for
credentials for the NTLM realm once or
multiple times.

realm

{add | demote | promote
| remove} realm_name
clear

Adds/demotes/promotes/
removes a realm from the realm
sequence, or clears all realms from the
realm sequence.

rename

new_realm_sequence_name

Renames this realm to
new_realm_sequence_name.

view
virtual-url

Displays this realm’s configuration.
url

Specifies the virtual URL to use for this
realm sequence. If no URL is specified
the global transparent proxy virtual URL
is used.

Example
SGOS#(config) security sequence edit-realm testsequence
SGOS#(config sequence testsequence) ntlm-only-once disable
ok
SGOS#(config sequence testsequence) realm clear
ok
SGOS#(config sequence testsequence) exit
SGOS#(config)

#(config) security siteminder edit-realm realm_name
Edits the SiteMinder realm sequence specified by realm_name.

Syntax
security siteminder edit-realm realm_name

This changes the prompt to:
SGOS#(config siteminder realm_name)

- subcommandsoption 1: add-header-responses {enable | disable}
option 2: alternate-agent {agent-name | encrypted-shared-secret | host | port |
shared-secret | always-redirect-offbox}
option 3: always-redirect-offbox {enable | disable}
option 4: cache-duration seconds
option 5: case-sensitive {enable | disable}
option 6: display-name display_name

171

Blue Coat ProxySG Command Line Interface Reference

option 7: exit
option 8: no
option 9: primary-agent {agent-name | encrypted-shared-secret | host | port |
shared-secret | always-redirect-offbox}
option 10: protected-resource-name resource-name
option 11: rename new_realm_name
option 12: server-mode {failover | round-robin}
option 13: siteminder-server {create | delete | edit}
option 14: ssl {enable | disable}
option 15: ssl-verify-agent {enable | disable}
option 16: timeout seconds
option 17: view
option 18: virtual-url url
Table 3.74: #(config siteminder realm_name)
add-header-responses

enable | disable

Enable if your web applications
need information from the
SiteMinder policy server
responses.

alternate-agent

agent-name

Specifies the alternate agent.

encrypted-secret
encrypted_secret

Specifies the alternate agent secret
in encrypted format.

host

The host ID or the IP address of the
system that contains the alternate
agent.

port

The port where the agent listens.

shared-secret secret

Specifies the alternate agent secret.

always-redirectoffbox

enable | disable

Enables or disables SSO.

cache-duration

seconds

Specifies the length of time to cache
credentials for this realm.

case-sensitive
display-name

Specifies whether or not the
SiteMinder server is case-sensitive.
display_name

exit

no

172

Specifies the display name for this
realm.
Exits configure siteminder-realm
mode and returns to configure
mode.

alternate-agent

Clears the alternate agent
configuration.

Chapter 3: Privileged Mode Configure Commands

Table 3.74: #(config siteminder realm_name) (Continued)
primary-agent

agent-name

Specifies the primary agent.

encrypted-secret
encrypted_secret

Specifies the primary agent secret
in encrypted format.

host

The host ID or the IP address of the
system that contains the primary
agent.

port

The port where the agent listens.

shared-secret secret

Specifies the primary agent secret.

always-redirect-offbox (enable
| disable)

Enables or disables the SSO-Only
mode.

protected-resourcename

resource-name

The protected resource name is the
same as the resource name on the
SiteMinder server that has rules
and policy defined for it.

rename

new_realm_name

Renames this realm to new_realm.

server-mode

failover | round-robin

Behavior of the server. Failover
mode falls back to one of the other
servers if the primary one is down.
Round-robin modes specifies that
all of the servers should be used
together in a round-robin
approach. Failover is the default.

173

Blue Coat ProxySG Command Line Interface Reference

Table 3.74: #(config siteminder realm_name) (Continued)
siteminder-server

create

Create a SiteMinder server.

delete

Delete a SiteMinder server.

edit

Enter the SiteMinder server edit
mode.
The default is 44442. The ports
should be the same as the ports
configured on the SiteMinder
server. The valid port range is
1-65535.

authorization port
port_number

The default is 44443. The ports
should be the same as the ports
configured on the SiteMinder
server. The valid port range is
1-65535.

accounting port
port_number

The default is 44441. The ports
should be the same as the ports
configured on the SiteMinder
server. The valid port range is
1-65535.

connectionincrement number

The default is 1. The connection
increment specifies how many
connections to open at a time if
more are needed and the maximum
is not exceeded.

exit

Takes you out of the
siteminder-server edit mode.

ip-address

The IP address of the SiteMinder
server.

maxconnections number

The default is 256. The maximum
number of connections is 32768

minconnections number

The default is 1.

timeout seconds

The default is 60.

view

Displays the server’s configuration.

ssl

disable | enable

Disables/enables SSL
communication between the
ProxySG and BCAAA.

ssl-verify-agent

disable | enable

Specifies whether or not to verify
the BCAAA certificate.

timeout

seconds

view
virtual-url

174

authentication port
port_number

Displays this realm’s configuration.
url

Specifies the virtual URL to use for
this SiteMinder realm. If no URL is
specified the global transparent
proxy virtual URL is used.

Chapter 3: Privileged Mode Configure Commands

Example
SGOS#(config) security siteminder edit-realm test2
SGOS#(config siteminder test2) server-mode round-robin
ok
SGOS#(config siteminder test2) ssl enable
ok
SGOS#(config siteminder test2) exit
SGOS#(config)

#(config) serial-number
This command configures the ProxySG serial number.

Syntax
option 1: serial-number serial_number
Table 3.75: #(config) serial-number
serial_number

Configures the ProxySG serial number.

Example
SGOS#(config) serial-number xxx
ok

#(config) services
Use this command to configure DNS, FTP, HTTPS, IM, SSH, and Telnet services.

Syntax
services

This changes the prompt to:
SGOS#(config services)

- subcommandsoption 1: aol-im—changes the prompt (see “#(config services) aol-im” on page 177)
option 2: dns—changes the prompt (see “#(config services) dns” on page 178)
option 3: exit
option 4: ftp—changes the prompt (see “#(config services) ftp” on page 179)
option 5: http—changes the prompt (see “#(config services) http” on page 180)
option 6: https—changes the prompt (see “#(config services) https” on page 182)
option 7: http-console—changes the prompt (see “#(config services) http-console” on
page 184)

option 8: https-console—changes the prompt (see “#(config services) https-console” on
page 185)

option 9: mms—changes the prompt (see “#(config services) mms” on page 186)

175

Blue Coat ProxySG Command Line Interface Reference

option 10: msn-im—changes the prompt (see “#(config services) msn-im” on page 187)
option 11: rtsp—changes the prompt (see “#(config services) rtsp” on page 188)
option 12: socks—changes the prompt (see “#(config services) socks” on page 190)
option 13: ssh-console—changes the prompt (see “#(config services) ssh-console” on
page 191)

option 14: tcp-tunnel—changes the prompt (see “#(config services) tcp-tunnel” on
page 193)

option 15: telnet—changes the prompt (see “#(config services) telnet” on page 194)
option 16: telnet-console—changes the prompt (see “#(config services) telnet-console”
on page 195)

option 17: view
option 18: yahoo-im—changes the prompt (see “#(config services) yahoo-im” on page 196)
Table 3.76: #(config services)

176

aol-im

Configures AOL IM services. See
“#(config services) aol-im” on
page 177.

dns

Configures DNS services. See “#(config
services) dns” on page 178.

exit

Exits the config services mode and
returns to the config prompt.

ftp

Configures transparent or explicit FTP
services. See “#(config services)
ftp” on page 179.

http

Configures HTTP services. See “#(config
services) http” on page 180.

https

Configures HTTPS services. See
“#(config services) https” on
page 182.

http-console

Configures HTTP Console services. See
“#(config services)
http-console” on page 184.

https-console

Configures HTTPS Console services. See
“#(config services)
https-console” on page 185.

mms

Configures MMS services. See “#(config
services) mms” on page 186.

msn-im

Configures MSN IM services. See
“#(config services) msn-im” on
page 187.

rtsp

Configures RTSP services. See “#(config
services) rtsp” on page 188.

socks

Configures SOCKS services. See
“#(config services) socks” on
page 190.

Chapter 3: Privileged Mode Configure Commands

Table 3.76: #(config services) (Continued)
ssh-console

Configures SSH services. See “#(config
services) ssh-console” on page 191.

tcp-tunnel

Configures TCP-tunneling services. See
“#(config services) tcp-tunnel”
on page 193.

telnet

Configures Telnet services. See “#(config
services) telnet” on page 194.

telnet-console

Configures Telnet Console services. See
“#(config services)
telnet-console” on page 195.

view

Displays all services-related configuration
information.

yahoo-im

Configures Yahoo IM services. See
“#(config services) yahoo-im” on
page 196.

Example
SGOS#(config services) view
Port:
8080
Type: http
Properties: enabled, explicit-proxy
Port:
80
Type: http
Properties: enabled, transparent, explicit-proxy
Port:
21
Type: ftp
Properties: enabled, transparent
SGOS#(config services) exit
SGOS#(config)

#(config services) aol-im
Use this command to configure AOL instant messaging services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
aol-im

This changes the prompt to:
SGOS#(config services aol-im)

- subcommandsoption 1: attribute send-client-ip {disable | enable} port
option 2: create port
option 3: delete port
option 4: disable port

177

Blue Coat ProxySG Command Line Interface Reference

option 5: enable port
option 6: exit
option 7: view
Table 3.77: #(config services aol-im)
attribute
send-client-ip

disable port

Disables spoof attribute for listener.

enable port

Enables spoof attribute for listener.

create

port

Creates an AOL-IM services listener.

delete

port

Deletes an AOL-IM services listener.

disable

port

Disables an AOL-IM services listener. This
is the default setting.

enable

port

Enables an AOL-IM services listener.

exit

Exits configure services aol-im mode and
returns to configure services mode.

view

Shows the AOL-IM services configuration.

Example
SGOS#(config) services
SGOS#(config services) aol-im
SGOS#(config services aol-im) create 2003
ok
SGOS#(config services aol-im) exit
SGOS#(config services)

#(config services) dns
Use this command to configure DNS services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
dns

This changes the prompt to:
SGOS#(config services dns)

- subcommandsoption 1: attribute
sub-option 1: explicit {disable | enable} [ip:]port
sub-option 2: transparent {disable | enable} [ip:]port

option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port

178

Chapter 3: Privileged Mode Configure Commands

option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.78: #(config services dns)
attribute

explicit {disable |
enable} [ip:]port

Disables or enables explicit-proxy attribute
for listener.

transparent {disable |
enable} [ip:]port

Disables or enables transparent attribute of
listener.

create

[ip:]port

Creates a DNS services listener.

delete

[ip:]port

Deletes a DNS services listener.

disable

[ip:]port

Disables a DNS services listener.

enable

[ip:]port

Enables a DNS services listener.

exit

Exits configure services dns mode and
returns to configure services mode.

view

Shows the DNS services configuration.

Example
SGOS#(config) services
SGOS#(config services) dns
SGOS#(config services dns) create 1
ok
SGOS#(config services dns) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) ftp
Use this command to configure transparent FTP services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
ftp

This changes the prompt to:
SGOS#(config services ftp)

- subcommandsoption 1: attribute {explicit {disable | enable} [ip:]port | passive-mode {disable
| enable} [ip:]port | transparent {disable | enable} [ip:]port}
option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port

179

Blue Coat ProxySG Command Line Interface Reference

option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.79: #(config services ftp)
attribute

explicit {disable |
enable} [ip:]port

Disables or enables explicit-proxy attribute
for listener.

passive-mode {disable |
enable}

Disables or enables support for passive
mode to clients.

transparent {disable |
enable} [ip:]port

Disables or enables transparent attribute of
listener.

create

[ip:]port

Creates a transparent FTP services port.

delete

[ip:]port

Deletes a transparent FTP services port.

disable

[ip:]port

Disables the transparent FTP services port.

enable

[ip:]port

Enables the transparent FTP services port.

exit

Exits configure services ftp mode and
returns to configure services mode.

view

Displays the transparent FTP services
configuration.

Example
SGOS#(config) services
SGOS#(config services) ftp
SGOS#(config services ftp) create 2003
ok
SGOS#(config services ftp) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) http
Use this command to create and configure HTTP services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
http

This changes the prompt to:
SGOS#(config services http)

- subcommandsoption 1: attribute
sub-option 1: authenticate-401 {disable | enable} [ip:]port

180

Chapter 3: Privileged Mode Configure Commands

sub-option 2: explicit {disable | enable} [ip:]port
sub-option 3: send-client-ip {disable | enable} [ip:]port
sub-option 4: transparent {disable | enable} [ip:]port
sub-option 5: head {disable {drop | error} [ip:]port | enable [ip:]port}
sub-option 6: connect {disable {drop | error} [ip:]port | enable [ip:]port}

option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.80: #(config services-http)
attribute

authenticate-401
{disable | enable
[ip:]port}

Enables or disables transparent
authentication.

explicit {disable |
enable [ip:]port}

Accepts or rejects requests for
non-transparent content.

send-client-ip {disable
| enable [ip:]port}

Enables or disables the spoof attribute.

transparent {disable |
enable [ip:]port}

Accepts or rejects requests for transparent
content.

head {disable {drop |
error} [ip:]port |
enable [ip:]port}

Allows or prevents blocking of HEAD
requests.

connect {disable {drop
| error} [ip:]port |
enable [ip:]port}

Allows or blocks CONNECT requests.

create

[ip:]port

Creates an HTTP services listener port.

delete

[ip:]port

Deletes the specified HTTP services
listener port.

disable

[ip:]port

Disables the HTTP services on the
specified port.

enable

[ip:]port

Enables the HTTP services on the specified
port.

exit

Exits configure services HTTP mode and
returns to configure services mode.

view

Displays the HTTP services configuration.

Example
SGOS#(config) services
SGOS#(config services) http
SGOS#(config services http) create 8085
ok
SGOS#(config services http) attribute authenticate-401 enable 8085
ok

181

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config services http) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) https
Use this command to create and configure HTTPS services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
https

This changes the prompt to:
SGOS#(config services https)

- subcommandsoption 1: attribute
sub-option 1: ccl ip:port
sub-option 2: cipher-suite ip:port
sub-option 3: forward-client-cert {disable | enable} ip:port
sub-option 4: send-client-ip {disable | enable} ip:port
sub-option 5: ssl-protocol-version {sslv2 | sslv3 | tlsv1 | sslv2v3| sslv2tlsv1 |
sslv3tlsv1 | sslv2v3tlsv1} ip:port
sub-option 6: verify-client {disable | enable} ip:port

option 2: create ip:port keyring id
option 3: delete
sub-option 1: attribute ccl ip:port
sub-option 2: ip:port

option 4: disable ip:port
option 5: enable ip:port
option 6: exit
option 7: view

182

Chapter 3: Privileged Mode Configure Commands

Table 3.81: #(config services https)
attribute

cipher-suite ip:port

Specifies the cipher suite to use.

ccl

Sets CA Certificate List to use for verifying
certificates.

ip:port

forward-client-cert
{disable | enable}
ip:port}

Enables or disables client certificate
forwarding

send-client-ip {disable
| enable} ip:port}

Enables or disables sending client's IP as
source IP address.

ssl-protocol-version
{sslv2 | sslv3 | tlsv1
| sslv2v3| sslv2tlsv1 |
sslv3tlsv1 |
sslv2v3tlsv1} ip:port

Specifies the SSL protocol version.

verify-client {disable
| enable} ip:port}

Enables or disables client verification.

create

ip:port keyring id

Creates an HTTPS services listener port.

delete

attribute ccl ip:port |
ip:port

Deletes the HTTPS services settings.

disable

ip:port

Disables the HTTPS services listener port.

enable

ip:port

Enables the HTTPS services listener port.

exit

Exits configure services HTTPS mode and
returns to configure services mode.

view

Displays the HTTPS services
configuration.

Example
SGOS#(config) services
SGOS#(config services) https
SGOS#(config services https) create 10.25.36.47:8085 default
ok
SGOS#(config services https) view
Port:
8085
IP: 10.25.36.47 Type: https
Keyring: default
Properties: transparent, explicit, enabled
SSL Protocol version: SSLv2v3TLSv1
CA Certificate List: not configured
Cipher suite:
RC4-MD5:RC4-SHA:DES-CBC3-SHA:DES-CBC3-MD5:RC2-CBC-MD5:RC4-64-MD5:DES-CBC-SHA:DES
-CBC-MD5:EXP1024-RC4-MD5:EXP1024-RC4-SHA:EXP1024-RC2-CBC-MD5:EXP1024-DES-CBC-SHA
:EXP-RC4-MD5:EXP-RC2-CBC-MD5:EXP-DES-CBC-SHA:+SSLv2:+SSLv3+LOW:+SSLv2+LOW:
+EXPO
SGOS#(config services https) exit
SGOS#(config services) exit
SGOS#(config)

183

Blue Coat ProxySG Command Line Interface Reference

#(config services) http-console
Use this command to create and configure an HTTP management console.

Syntax
services

This changes the prompt to:
SGOS#(config services)
http-console

This changes the prompt to:
SGOS#(config services http-console)

- subcommandsoption 1: create [ip:]port
option 2: delete [ip:]port
option 3: disable [ip:]port
option 4: enable [ip:]port
option 5: exit
option 6: view
Table 3.82: #(config services http-console)
create

[ip:]port

Creates an HTTP Console services listener.

delete

[ip:]port

Deletes an HTTP Console services listener.

disable

[ip:]port

Disables an HTTP Console services
listener. This is the default setting.

enable

[ip:]port

Enables an HTTP Console services listener.

exit

Exits configure services
http-console mode and returns to
configure services mode.

view

Displays the HTTP Console services
configuration.

Example
SGOS#(config) services
SGOS#(config services) http-console
SGOS#(config services http-console) create 9000
ok
SGOS#(config services http-console) enable 9000
ok
SGOS#(config services http-console) view
Port:
9000
IP: 0.0.0.0
Type: management
Properties: explicit, enabled

184

Chapter 3: Privileged Mode Configure Commands

SGOS#(config services http-console) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) https-console
Use this command to create and configure an HTTPS management console.

Syntax
services

This changes the prompt to:
SGOS#(config services)
https-console

This changes the prompt to:
SGOS#(config services https-console)

- subcommandsoption 1: attribute cipher-suite [ip:]port
option 2: create [ip:]port [keyring_id]
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.83: #(config services https-console)
attribute cypher-suite

[ip:]port

Configures HTTPS Console services
cypher suite.

create

[ip:]port [keyring_id]

Creates an HTTPS Console services
listener.

delete

[ip:]port

Deletes an HTTPS Console services
listener.

disable

[ip:]port

Disables an HTTPS Console services
listener.

enable

[ip:]port

Enables an HTTPS Console services
listener.

exit

Exits configure services
https-console mode and returns to
configure services mode.

view

Displays the HTTPS Console services
configuration.

185

Blue Coat ProxySG Command Line Interface Reference

Example
SGOS#(config) services
SGOS#(config services) https-console
SGOS#(config services https-console) create 9000
ok
SGOS#(config services https-console) enable 9000
ok
SGOS#(config services https-console) view
Port:
9000
IP: 0.0.0.0
Type: management
Properties: explicit, enabled
SGOS#(config services https-console) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) mms
Use this command to create and configure MMS services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
mms

This changes the prompt to:
SGOS#(config services mms)

- subcommandsoption 1: attribute
sub-option 1: explicit {disable | enable} [ip:]port
sub-option 2: send-client-ip {disable | enable} [ip:]port
sub-option 3: transparent {{disable | enable} [ip:]port

option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port
option 6: exit
option 7: view

186

Chapter 3: Privileged Mode Configure Commands

Table 3.84: #(config services mms)
attribute

explicit {disable |
enable} [ip:]port

Disables or enables explicit-proxy attribute
for listener.

send-client-ip {disable
| enable} [ip:]port

Disables or enables spoof attribute for
listener.

transparent {disable |
enable} [ip:]port

Disables or enables transparent attribute
for listener.

create

[ip:]port

Creates an MMS services listener port.

delete

[ip:]port

Deletes the specified MMS services listener
port.

disable

[ip:]port

Disables the MMS services on the specified
port. This is the default setting.

enable

[ip:]port

Enables the MMS services on the specified
port.

exit

Exits configure services mms mode and
returns to configure services mode.

view

Displays the MMS services configuration.

Example
SGOS#(config) services
SGOS#(config services) mms
SGOS#(config services mms) create 8085
ok
SGOS#(config services mms) attribute explicit enable 8085
ok
SGOS#(config services mms) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) msn-im
Use this command to create and configure MSN instant messaging services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
msn-im

This changes the prompt to:
SGOS#(config services msn-im)

- subcommandsoption 1: attribute send-client-ip {disable | enable} port
option 2: create port

187

Blue Coat ProxySG Command Line Interface Reference

option 3: delete port
option 4: disable port
option 5: enable port
option 6: exit
option 7: view
Table 3.85: #(config services msn-im)
attribute
send-client-ip

{disable | enable} port

Disables or enables spoof attribute for
listener.

create

port

Creates an MSN IM services listener port.

delete

port

Deletes the specified MSN IM services
listener port.

disable

port

Disables the MSN IM services on the
specified port. This is the default setting.

enable

port

Enables the MSN IM services on the
specified port.

exit

Exits configure services msn-im mode and
returns to configure services mode.

view

Displays the MSN IM services
configuration.

Example
SGOS#(config) services
SGOS#(config services) msn-im
SGOS#(config services msn-im) create 8085
ok
SGOS#(config services msn-im) attribute send-client-ip enable 8085
ok
SGOS#(config services msn-im) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) rtsp
Use this command to create and configure RTSP services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
rtsp

This changes the prompt to:
SGOS#(config services rtsp)

188

Chapter 3: Privileged Mode Configure Commands

- subcommandsoption 1: attribute
sub-option 1: explicit {disable | enable} [ip:]port
sub-option 2: send-client-ip {disable | enable} [ip:]port
sub-option 3: transparent {disable | enable} [ip:]port

option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.86: #(config services rtsp)
attribute

explicit {disable |
enable} [ip:]port

Disables or enables explicit-proxy attribute
for listener.

send-client-ip {disable
| enable} [ip:]port

Disables or enables spoof attribute for
listener.

transparent {disable |
enable} [ip:]port

Disables or enables transparent attribute
for listener.

create

[ip:]port

Creates an RTSP services listener port.

delete

[ip:]port

Deletes the specified RTSP services listener
port.

disable

[ip:]port

Disables the RTSP services on the specified
port. This is the default setting.

enable

[ip:]port

Enables the RTSP services on the specified
port.

exit

Exits configure services rtsp mode and
returns to configure services mode.

view

Displays the RTSP services configuration.

Example
SGOS#(config) services
SGOS#(config services) rtsp
SGOS#(config services rtsp) create 8085
ok
SGOS#(config services rtsp) attribute explicit enable 8085
ok
SGOS#(config services rtsp) exit
SGOS#(config services) exit
SGOS#(config)

189

Blue Coat ProxySG Command Line Interface Reference

#(config services) socks
Use this command to create and configure SOCKS services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
socks

This changes the prompt to:
SGOS#(config services socks)

- subcommandsoption 1: create [ip]:port
option 2: delete [ip]:port
option 3: disable [ip]:port
option 4: enable [ip]:port
option 5: exit
option 6: view
Table 3.87: #(config services socks)
create

[ip:]port

Creates a SOCKS services listener port.

delete

[ip:]port

Deletes a SOCKS services listener.

disable

[ip:]port

Disables a SOCKS services listener. This is
the default setting.

enable

[ip:]port

Exits configure services socks mode and
returns to configure services mode.

view

Displays the SOCKS services
configuration.

Example
SGOS#(config) services
SGOS#(config services) socks
SGOS#(config services socks) create 8085
ok
SGOS#(config services socks) enable 8085
ok
SGOS#(config services socks) exit
SGOS#(config services) exit
SGOS#(config)

190

Enables a SOCKS services listener.

exit

Chapter 3: Privileged Mode Configure Commands

#(config services) ssh-console
The default connection to the ProxySG is SSH and HTTPS. All data transmitted between the SSH client
and SSH host is encrypted and decrypted using public and private keys established on the ProxySG
and by the SSH application on the client.
Note:

The ProxySG supports a combined maximum of 16 Telnet and SSH sessions. It also supports
up to 24 keys per user.

Before You Begin
SSHv2 is enabled and ready for use. You must create and enable SSHv1 if you want to use it. To use
SSH with RSA authentication, you must create a keypair in OpenSSH format through the SSH client
application, copy the keypair to the clipboard, and use the import client-key command to import
the key onto the ProxySG.

Syntax
services

This changes the prompt to:
SGOS#(config services)
ssh-console

This changes the prompt to:
SGOS#(config services ssh-console)

- subcommandsoption 1: create
sub-option 1: host-keypair {[sshv1] | [sshv2]}
sub-option 2: [ip]:port

option 2: delete
sub-option 1: client-key username key_id
sub-option 2: director-client-key key_id
sub-option 3: legacy-client-key key_id
sub-option 4: host-keypair {[sshv1] | [sshv2]}
sub-option 5: [ip]:port

option 3: disable [ip]:port
option 4: enable [ip]:port
option 5: exit
option 6: import client-key username | director-client-key
option 7: view
sub-option 1: client-key [username]
sub-option 2: director-client-key [key_id]
sub-option 3: host-public-key {[sshv1] | [sshv2]}

191

Blue Coat ProxySG Command Line Interface Reference

sub-option 4: user-list
sub-option 5: versions-enabled
Table 3.88: #(config services ssh-console)
create

host-keypair {[sshv1] |
[sshv2]}
[ip]:port

delete

client-key username
key_id

Deletes either the host keypair or the client
key associated with the indicated
username.

director-client-key
key_id

Deletes the client key associated with the
indicated username of a ProxySG that is
being used in Blue Coat Systems Director
configurations.

legacy-client-key
key_id

Deletes the client-key file (if you upgraded
from a previous version) with all its client
keys. This file does not contain client keys
created in SGOS v3.

host-keypair {[sshv1] |
[sshv2]}

Deletes the host-keypair associated with
SSHv1 or SSHv2.

[ip]:port

Deletes the SSH-console at the port
specified.

exit
import

view

Allows you to create a host keypair if one
has been deleted. Only two
keypairs—SSHv1 and SSv2—are allowed
on the ProxySG. The port number is
required.

Exits configure services ssh-console mode
and returns to configure services mode.
client-key username

Imports the client key associated with the
indicated username.

director-client-key

Imports the Director client key,
automatically determined from the
imported key.

client-key [username]

Displays the client key associated with the
indicated username or the legacy client
key fingerprints.

director-client-key
[key_id]

Displays the client key associated with the
indicated Director key_id or all client
fingerprints.

host-public-key
{[sshv1] | [sshv2]}

Displays the host-keypair associated with
SSHv1 or SSHv2.

user-list

Displays the list of users with imported
RSA client keys.

versions-enabled

Displays which SSH version(s) is enabled.

Example
SGOS#(config) services
SGOS#(config services) ssh-console
SGOS#(config services ssh-console) import client-key username
Paste client key here, end with "..." (three periods)
ssh-rsa

192

Chapter 3: Privileged Mode Configure Commands

AAAAB3NzaC1yc2EAAAABIwAAAIEAlV/xvN21VrOOK6sNuAnavWy9RsI8xgfD7OXQ4rocXrNm9kdnYBlO
zaDWgZ4mHUnTmBkmAJKaGJRfZMIQt2ZXF+biVHbOWyiznzbiDMkXEEI4PHXoqyWp5Bq7bI2RgDOVaMM1
vQT9uyenKymwZElDNe/tlRiGkDUN3/s3kX6xv0M= admin@GLYPH
...
ok
SGOS#(config services ssh-console) view client-key username
admin@adminPC 45:5C:3F:5F:EA:65:6E:CF:EE:4A:05:58:9A:C5:FB:4F
admin@GLYPH BB:20:21:4D:E0:BC:32:39:13:55:2E:B4:07:81:4F:AV
SGOS#(config services socks) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) tcp-tunnel
Use this command to create, enable, and configure TCP-tunnel services. Multiple TCP-tunnel services
are supported.
Note:

TCP-tunnel services are not created by default—you must create and enable them.

Syntax
services

This changes the prompt to:
SGOS#(config services)
tcp-tunnel

This changes the prompt to:
SGOS#(config services tcp-tunnel)

- subcommandsoption 1: attribute
sub-option 6: explicit {disable | enable} [ip:]port}
sub-option 7: transparent {disable | enable} [ip:]port

option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.89: #(config services tcp-tunnel)
attribute

explicit {disable |
enable} [ip:]port

Enables or disables the explicit TCP-tunnel
port.

transparent {disable |
enable} [ip:]port

Enables or disables the transparent
TCP-tunnel port.

193

Blue Coat ProxySG Command Line Interface Reference

Table 3.89: #(config services tcp-tunnel) (Continued)
create

[ip:]port

Creates a TCP-tunnel port.

delete

[ip:]port

Deletes the TCP-tunnel services settings.

disable

[ip:]port

Disables the TCP-tunnel port.

enable

[ip:]port

Enables the TCP-tunnel port.

exit

Exits configure services tcp-tunnel mode
and returns to configure services mode.

view

Displays the TCP-tunnel services
configuration.

Example
SGOS#(config) services
SGOS#(config services) tcp-tunnel
SGOS#(config services tcp-tunnel) create 0.0.0.0:9001
ok
SGOS#(config services tcp-tunnel) view
Port:
9001
IP: 0.0.0.0
Type: tcp-tunnel
Properties: transparent, enabled
SGOS#(config services tcp-tunnel) exit
SGOS#(config services) exit
SGOS#(config)

#(config services) telnet
Use this command to create and configure Telnet services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
telnet

This changes the prompt to:
SGOS#(config services telnet)

- subcommandsoption 1: attribute
sub-option 1: explicit
sub-option 2: send-client-ip
sub-option 3: transparent

option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port

194

Chapter 3: Privileged Mode Configure Commands

option 6: exit
option 7: view
Table 3.90: #(config services telnet)
attribute

explicit {disable |
enable} [ip:]port

Specifies whether to accept or not to accept explicit proxy
requests for the port and optional IP address specified.

send-client-ip
{disable | enable}
[ip:]port

Enables or disables the spoof attribute for the port and
optional IP address specified.

transparent
{disable | enable}
[ip:]port

Enables or disables the transparent proxy attribute for the
port and optional IP address specified.

create

[ip:]port

Creates a Telnet services port indicated by [ip:]port.
Note that if you also enable the Telnet-Console you must
use a different port for the Telnet service.

delete

[ip:]port

Deletes the Telnet services port indicated by [ip:]port.

disable

[ip:]port

Disables the Telnet services port.

enable

[ip:]port

Enables the Telnet services port.

exit

Exits configure services telnet-console mode and returns
to configure services mode.

view

Displays the Telnet services configuration.

Example
SGOS#(config) services
SGOS#(config services) telnet
SGOS#(config services telnet) create 10.25.36.47:24
ok
SGOS#(config services telnet) attribute send-client-ip enable 10.25.36.47:24
ok
SGOS#(config services telnet) view
Port:
23
IP: 0.0.0.0
Type: telnet
Properties: transparent, explicit, disabled
Port:
24
IP: 10.25.36.47:24
Type: telnet
Properties: explicit, enabled, send-client-ip

#(config services) telnet-console
Use this command to enable and configure the Telnet Console, which allows you to connect to the
ProxySG with the Telnet protocol. Remember that Telnet is an insecure protocol that should not be
used in insecure conditions.

Syntax
services

This changes the prompt to:
SGOS#(config services)
telnet-console

195

Blue Coat ProxySG Command Line Interface Reference

This changes the prompt to:
SGOS#(config services telnet-console)

- subcommandsoption 1: create [ip:]port
option 2: delete [ip:]port
option 3: disable [ip:]port
option 4: enable [ip:]port
option 5: exit
option 6: view
Table 3.91: #(config services telnet-console)
create

[ip:]port

Creates a Telnet-Console services port indicated by [ip:]port. Note
that if you also enable Telnet you must use a different port for the
Telnet-Console service.

delete

[ip:]port

Deletes the Telnet-Console services port indicated by [ip:]port.

disable

[ip:]port

Disables the Telnet-Console services port.

enable

[ip:]port

Enables the Telnet-Console services port.

exit

Exits configure services Telnet-Console mode and returns to configure
services mode.

view

Displays the Telnet-Console services configuration.

Example
SGOS#(config) services
SGOS#(config services) telnet-console
SGOS#(config services telnet-console) create 10.25.36.47:25
ok
SGOS#(config services telnet-console) view
Port:
25
IP: 10.25.36.47 Type: telnet-console
Properties: enabled

#(config services) yahoo-im
Use this command to create and configure Yahoo instant messaging services.

Syntax
services

This changes the prompt to:
SGOS#(config services)
yahoo-im

This changes the prompt to:
SGOS#(config services yahoo-im)

196

Chapter 3: Privileged Mode Configure Commands

- subcommandsoption 1: attribute send-client-ip {disable | enable} port
option 2: create [ip:]port
option 3: delete [ip:]port
option 4: disable [ip:]port
option 5: enable [ip:]port
option 6: exit
option 7: view
Table 3.92: #(config services yahoo-im)
attribute

send-client-ip
{disable port | enable
port}

Disables or enables spoof attribute for listener.

create

port

Creates a Yahoo IM services listener port.

delete

port

Deletes the specified Yahoo IM services listener port.

disable

port

Disables the Yahoo IM services on the specified port.

enable

port

Enables the Yahoo IM services on the specified port.

exit

Exits configure services yahoo-im mode and returns
to configure services mode.

view

Displays the Yahoo IM services configuration.

Example
SGOS#(config) services
SGOS#(config services) yahoo-im
SGOS#(config services yahoo-im) create 8085
ok
SGOS#(config services yahoo-im) attribute transparent enable 8085
ok
SGOS#(config services yahoo-im) exit
SGOS#(config services) exit
SGOS#(config)

#(config) shell
Use this command to configure options for the shell.
option 1: shell max-connections
option 2: shell no
option 3: shell prompt
option 4: shell realm-banner
option 5: shell welcome-banner

197

Blue Coat ProxySG Command Line Interface Reference

Table 3.93: #(config) shell
max-connections

number

Maximum number of shell connections. Allowed values are between
1 and 65535.

no

string

Disables the prompt, realm-banner, and welcome-banner strings.

prompt

string

Sets the prompt that the user sees in the shell. If the string includes
white space, enclose the string in quotes.

realm-banner

string

Sets the realm banner that the user sees when logging into a realm
through the shell. If the string includes white space, enclose the string
in quotes.

welcome-banner

string

Sets the welcome banner that the users sees when logging into the
shell. If the string includes white space, enclose the string in quotes.

Example
SGOS#(config) shell prompt "Telnet Shell >"
ok
SGOS#(config) shell welcome-banner "Welcome to the Blue Coat Systems Telnet
Shell"
ok

#(config) show
See “# show” on page 40 in Chapter 2: Standard and Privileged Mode Commands.

#(config) snmp
Use this command to set SNMP (Simple Network Management Protocol) options for the ProxySG.
The ProxySG can be viewed using an SNMP management station. The ProxySG supports MIB-2 (RFC
1213).

Syntax
snmp

This changes the prompt to:
SGOS#(config snmp)

- subcommandsoption 1: authorize-traps
option 2: disable
option 3: enable
option 4: encrypted-read-community encrypted_password
option 5: encrypted-trap-community encrypted_password
option 6: encrypted-write-community encrypted_password
option 7: exit

198

Chapter 3: Privileged Mode Configure Commands

option 8: no
sub-option 1: authorize-traps
sub-option 2: sys-contact
sub-option 3: sys-location
sub-option 4: trap-address {1 | 2 | 3}

option 9: read-community password
option 10: reset-configuration
option 11: snmp-writes {disable | enable}
option 12: sys-contact string
option 13: sys-location string
option 14: trap-address {1 | 2 | 3} ip_address
option 15: trap-community password
option 16: view
option 17: write-community password
Table 3.94: #(config snmp)
authorize-traps

Enables SNMP authorize traps.

disable

Disables SNMP for the ProxySG.

enable

Enables SNMP for the ProxySG.

encrypted-read-communit
y

encrypted_password

Specifies encrypted read community
string.

encrypted-trap-communit
y

encrypted_password

Specifies encrypted trap community
string.

encrypted-writecommunity

encrypted_password

Specifies encrypted write community
string.

exit
no

read-community

Exits configure snmp mode and returns to
configure mode.
authorize-traps

Disables the current authorize traps
settings.

sys-contact

Disables the current system contact
settings.

sys-location

Disables the current system location
settings.

trap-address {1 | 2 |
3}

Disables the current trap address settings
(for trap address 1, 2, or 3).

password

Sets the read community password or
encrypted-password.

reset-configuration

Resets the SNMP configuration to the
default settings.

snmp-writes

{disable | enable}

Enables or disables SNMP write capability.

sys-contact

string

Sets the "sysContact" MIB variable to
string.

199

Blue Coat ProxySG Command Line Interface Reference

Table 3.94: #(config snmp) (Continued)
sys-location

string

Sets the "sysLocation" MIB variable to
string.

trap-address

{1 | 2 | 3} ip_address

Indicates which IP address(es) can receive
traps and in which priority.

trap-community

password

Sets the trap community password or
encrypted-password.

view
write-community

Displays SNMP settings.
password

Sets the write community password or
encrypted-password.

Example
SGOS#(config) snmp
SGOS#(config snmp) authorize-traps
ok
SGOS#(config snmp) exit
SGOS#(config)

#(config) socks-gateways
Use this command to set the SOCKS gateways settings.

Syntax
socks-gateways

This changes the prompt to:
SGOS#(config socks-gateways)

- subcommandsoption 1: create gateway_alias gateway_host SOCKS_port [version={4 | 5
[user=username password=password]}]
option 2: delete {all | gateway gateway_alias}
option 3: edit gateway_alias—changes the prompt (see “#(config socks-gateways) edit
gateway_alias” on page 201)

option 4: exit
option 5: failure-mode {closed | open}
option 6: no path
option 7: path url
option 8: sequence
sub-option 1: add gateway_alias
sub-option 2: clear
sub-option 3: demote gateway_alias
sub-option 4: promote gateway_alias
sub-option 5: remove gateway_alias

200

Chapter 3: Privileged Mode Configure Commands

option 9: view
Table 3.95: #(config socks-gateways)
create

gateway_alias
gateway_host SOCKS_port
[version={4 | 5
[user=username
password=password]}]

Creates a SOCKS gateway.

delete

all | gateway
gateway_alias

Deletes a SOCKS gateway.

edit

gateway_alias

Changes the prompt. See “#(config
socks-gateways) edit
gateway_alias” on page 201.

exit
failure-mode

Exits configure socks-gateways mode and
returns to configure mode.
closed | open

no path

Sets the default failure mode (which can be
overridden by policy).
Clears network path to download SOCKS
gateway settings.

path

url

Specifies the network path to download
SOCKS gateway settings.

sequence

add gateway_alias

Adds an alias to the end of the default
failover sequence.

clear

Clears the default failover sequence.

demote gateway_alias

Demotes an alias one place towards the
end of the default failover sequence.

promote gateway_alias

Promotes an alias one place towards the
start of the default failover sequence.

remove gateway_alias

Removes an alias from the default failover
sequence.

view

Displays all SOCKS gateways.

Example
SGOS#(config) socks-gateways
SGOS#(config socks-gateways) failure-mode open
ok
SGOS#(config socks-gateways) exit
SGOS#(config)

#(config socks-gateways) edit gateway_alias
These commands allow you to edit the settings of a specific SOCKS gateway.

Syntax
socks-gateways

This changes the prompt to:
SGOS#(config socks-gateways)

201

Blue Coat ProxySG Command Line Interface Reference

edit gateway_alias

This changes the prompt to:
SGOS#(config socks-gateways gateway_alias)

- subcommandsoption 1: exit
option 2: host
option 3: no
option 4: password
option 5: port
option 6: user
option 7: version
option 8: view
Table 3.96: #(config socks-gateways gateway_alias)
exit

Exits configure socks-gateways
gateway_alias mode and returns to
configure socks-gateways mode.

host

gateway_host

Changes the host name.

no

password | user

Optional, and only if you use version 5.
Deletes the version 5 password or
username.

password

password

Optional, and only if you use version 5.
Changes the version 5 password. If you
specify a password, you must also specify
a username.

port

SOCKS_port

Changes the SOCKS port.

user

user_name

Optional, and only if you use version 5.
Changes the version 5 username. If you
specify a username, you must also specify
a password.

version

4 | 5

Changes the SOCKS version.

view

Shows the current settings for this SOCKS
gateway.

Example
SGOS#(config) socks-gateways
SGOS#(config socks-gateways) edit testgateway
SGOS#(config socks-gateways testgateway) version 5
ok
SGOS#(config socks-gateways testgateway) exit
SGOS#(config socks-gateways) exit
SGOS#(config)

202

Chapter 3: Privileged Mode Configure Commands

#(config) socks-machine-id
Use this command to set the machine ID for SOCKS.
If you are using a SOCKS server for the primary or alternate gateway, you must specify the ProxySG
machine ID for the Identification (Ident) protocol used by the SOCKS gateway.

Syntax
socks-machine-id machine_id
Table 3.97: #(config) socks-machine-id
machine_id

Indicates the machine ID for the SOCKS
server.

Example
SGOS#(config) socks-machine-id 10.25.36.47
ok

#(config) socks-proxy
Use this command to configure a SOCKS proxy on a ProxySG. Only one server is permitted per
ProxySG. Both SOCKSv4 and SOCKSv5 are supported by Blue Coat Systems, and both are enabled by
default.
Note:

The version of SOCKS used is only configurable through policy. For example, to use only
SOCKSv5:


socks.version=4 deny

Syntax
socks-proxy

- subcommandsoption 1: socks-proxy accept-timeout seconds
option 2: socks-proxy connect-timeout seconds
option 3: socks-proxy max-connections num_connections
option 4: socks-proxy max-idle-timeout seconds
option 5: socks-proxy min-idle-timeout seconds
Table 3.98: #(config) socks-proxy
accept-timeout

seconds

Sets maximum time to wait on an inbound
BIND.

connect-timeout

seconds

Sets maximum time to wait on an
outbound CONNECT.

max-connections

num_connections

Sets maximum allowed SOCKS client
connections.

203

Blue Coat ProxySG Command Line Interface Reference

Table 3.98: #(config) socks-proxy (Continued)
max-idle-timeout

seconds

Sets maximum SOCKS client idle time
threshold.

min-idle-timeout

seconds

Sets minimum SOCKS client idle time
threshold.

Example
SGOS#(config) socks-proxy accept-timeout 120
ok

#(config) splash-generator
Use this command to display a custom message page, or splash page, to a user the first time he or she
starts the client browser. Subsequent URL requests from the client then provide the user with the
requested content.

Syntax
splash-generator

This changes the prompt to:
SGOS#(config splash-generator)

- subcommandsoption 1: cluster
sub-option 1: disable
sub-option 2: enable
sub-option 3: peer-ip 1 - 5 ip_address
sub-option 4: sdp-port port

option 2: disable
option 3: enable
option 4: exit
option 5: protocol {tacacs | radius}
option 6: radius
sub-option 1: acct-listen-port port
sub-option 2: auth-listen-port port
sub-option 3: encrypted-secret-key key
sub-option 4: forwarding {disable | ip-spoof | proxy-state}
sub-option 5: no secret-key
sub-option 6: secret-key key

option 7: tacacs
sub-option 1: encrypted-secret-key key
sub-option 2: forwarding {disable | enable}

204

Chapter 3: Privileged Mode Configure Commands

sub-option 3: listen-port port
sub-option 4: multi-session {disable | enable}
sub-option 5: no {all-servers | one-server ip_address [port] | secret-key}
sub-option 6: server ip_address [port]
sub-option 7: secret-key key

option 8: timeout seconds
option 9: view
Table 3.99: #(config splash-generator)
cluster

disable

Disables splash-generator cluster support.

enable

Enables splash-generator cluster support.

peer-ip {1 - 5
ip_address}

Indicates the cluster peer address.

sdp-port port

Indicates the Session Distributor Protocol
port.

disable

Disables the splash generator.

enable

Enables the splash generator.

exit

Exits configure splash generator mode and
returns to configure mode.

protocol

radius

tacacs

Indicates that the TACACS+ protocol
should be used.

radius

Indicates that the RADIUS protocol should
be used.

acct-listen-port port

Listens for incoming RADIUS accounting
requests on the port indicated by port.

auth-listen-port port

Listens for incoming RADIUS
authorization requests on the port
indicated by port.

encrypted-secret-key
encrypted-key

Sets the encrypted secret key to
encrypted-key.

forwarding {disable |
ip-spoof | proxy-state}

Disables forwarding of RADIUS requests,
or enables forwarding of RADIUS packets
using IP spoofing, or enables forwarding
of RADIUS packets using proxy state.

no secret key

Sets the MD5 secret key to an empty string.

secret-key key

Sets the MD5 secret key to key.

205

Blue Coat ProxySG Command Line Interface Reference

Table 3.99: #(config splash-generator) (Continued)
tacacs

timeout

encrypted-secret-key
encrypted-key

Sets the encrypted secret key to
encrypted-key.

forwarding {disable |
enable}

Disables or enables forwarding of
TACACS+ requests.

listen-port port

Listens for incoming TACACS+ requests
on the port indicated by port.

multi-session {disable
| enable}

Disables or enables multiple TACACS+
sessions capability.

no all-servers

Removes all TACACS+ server entries.

no one-server
ip_address [port]

Removes the TACACS+ server entry
indicated by ip_address.

no secret-key

Sets the secret key to an empty string.

server ip_address
[port]

Adds the server indicated by ip_address
to the TACACS+ server list.

secret-key key

Sets the secret key to key.

seconds

Indicates the splash timeout in seconds.

Example
SGOS#(config) splash-generator
SGOS#(config splash-generator) enable
ok
SGOS#(config splash-generator) protocol radius
ok
SGOS#(config splash-generator) exit
SGOS#(config)

#(config) ssl
Use this command to configure HTTPS termination, including managing certificates, both self-signed
and those from a Certificate Signing Authority (CSA).
To configure HTTPS termination, you must complete the following tasks:


Configure a keyring



Configure the SSL client



Configure the HTTPS service

Note:

To perform these steps, you must have a serial or SSH connection; you cannot use Telnet.

Syntax
ssl

This changes the prompt to:
SGOS#(config ssl)

206

Chapter 3: Privileged Mode Configure Commands

- subcommandsoption 1: create
sub-option 1: ccl list_name
sub-option 2: certificate keyring_id
sub-option 3: keyring {no-show | show} keyring_id [key_length]
sub-option 4: signing-request keyring_id
sub-option 5: ssl-client ssl_client_name (only default is permitted)

option 2: delete
sub-option 1: ca-certificate name
sub-option 2: ccl list_name
sub-option 3: certificate keyring_id
sub-option 4: external-certificate name
sub-option 5: keyring keyring_id
sub-option 6: signing-request keyring_id
sub-option 7: ssl-client ssl_client_name

option 3: edit
sub-option 1: ccl list_name—changes the prompt (see “#(config ssl) edit ccl list_name”
on page 209)
sub-option 2: ssl-client ssl_client_name (only default is permitted)—changes the
prompt (see “#(config ssl) edit ssl-client ssl_client_name” on page 210)

option 4: exit
option 5: import
sub-option 1: ca-certificate name
sub-option 2: certificate keyring_id
sub-option 3: external-certificate name
sub-option 4: keyring {no-show | show} keyring_id
sub-option 5: signing-request keyring_id

option 6: ssl-nego-timeout seconds
option 7: view
sub-option 1: ca-certificate name
sub-option 2: ccl
sub-option 3: certificate keyring_id
sub-option 4: external-certificate name
sub-option 5: keypair {des | des3 | unencrypted} keyring_id | keyring_id}
sub-option 6: keyring [keyring_id]
sub-option 7: signing-request keyring_id
sub-option 8: ssl-client
sub-option 9: ssl-nego-timeout
sub-option 10: summary {ca-certificate | external-certificate} [name]

207

Blue Coat ProxySG Command Line Interface Reference

Table 3.100: #(config ssl)
create

delete

edit

ccl list_name

Creates a list to contain CA certificates.

certificate keyring_id

Creates a certificate. Certificates can be
associated with a keyring.

keyring {no-show |
show} keyring_id
[key_length]

Creates a keyring, with a keypair. The
show | no-show option indicates whether
the keypair is viewable.

signing-request
keyring_id

Creates a certificate signing request. The
request must be associated with a keyring.

ssl-client
ssl_client_name

Associates the SSL client with a keyring.
Only the default is permitted.

ca-certificate name

Deletes a CA-certificate from the ProxySG.

ccl list_name

Deletes a CCL list from the ProxySG

certificate keyring_id

Deletes the certificate associated with a
keyring.

external-certificate
name

Deletes an external certificate from the
ProxySG.

keyring keyring_id

Deletes a keyring, with a keypair.

signing-request
keyring_id

Deletes a certificate signing request.

ssl-client
ssl_client_name

Deletes an SSL client.

ccl list_name

Changes the prompt. See “#(config
ssl) edit ccl list_name” on
page 209.

ssl-client
ssl_client_name

Changes the prompt. See “#(config
ssl) edit ssl-client
ssl_client_name” on page 210.

exit
import

ssl-nego-timeout

208

Exits configure ssl mode and returns to
configure mode.
ca-certificate name

Imports a CA certificates.

certificate keyring_id

Imports a certificates.

external-certificate
name

Imports a certificate without the
corresponding private key.

keyring {no-show |
show} keyring_id

Imports a keyrings.

signing-request
keyring_id

Imports a signing requests.

seconds

Configures the SSL-negotiation timeout
period.

Chapter 3: Privileged Mode Configure Commands

Table 3.100: #(config ssl) (Continued)
view

ca-certificate name

Displays the Certificate Authority
certificate.

ccl

Displays the CA-certificate lists.

certificate keyring_id

Displays the certificate.

external-certificate
name

Displays the external certificate.

keypair {des | des3 |
unencrypted} keyring_id
| keyring_id}

Displays the keypair.

keyring [keyring_id]

Displays the keyring.

signing-request
keyring_id

Displays the certificate signing request.

ssl-client

Displays summary information of SSL
clients.

ssl-nego-timeout

Displays SSL negotiation timeout period
status summary.

summary {ca-certificate
| external-certificate}
[name]

Displays a summary for all CA-certificate
or external-certificate commands, or for the
certificate name specified.

Examples:
SGOS#(config) ssl
SGOS#(config ssl) create keyring show keyring id [key length]
ok
SGOS#(config ssl) view keyring keyring id
KeyringID: default
Is private key showable? yes
Have CSR? no
Have certificate? yes
Is certificate valid? yes
CA: Blue Coat Systems SG3000
Expiration Date: Jan 23 23:57:21 2013 GMT
Fingerprint: EB:BD:F8:2C:00:25:84:02:CB:82:3A:94:1E:7F:0D:E3
SGOS#(config ssl) exit
SGOS#(config)

#(config ssl) edit ccl list_name
Allows you to edit the CCL parameters.

Syntax
ssl

This changes the prompt to:
SGOS#(config ssl)
edit ccl list_name

This changes the prompt to:

209

Blue Coat ProxySG Command Line Interface Reference

SGOS#(config ssl ccl list_name)

- subcommandsoption 1: add ca_certificate_name
option 2: exit
option 3: remove ca_certificate_name
option 4: view
Table 3.101: #(config ssl ccl list_name)
add

ca_certificate_name

exit
remove

Adds a CA certificate to this list. (The CA
certificate must first be imported in
configure ssl mode.)
Exits configure ssl ccl list_name mode
and returns to ssl configure mode.

ca_certificate_name

view

Deletes a CA certificate from this list.
Shows a summary of CA certificates in this
list.

Examples:
SGOS#(config) ssl
SGOS#(config ssl) edit ccl list_name
SGOS#(config ssl ccl list_name) add CACert1
ok
SGOS#(config ssl ccl list_name) exit
SGOS#(config ssl) exit
SGOS#(config)

#(config ssl) edit ssl-client ssl_client_name
Allows you to edit the SSL client parameters. Only the default is permitted.

Syntax
ssl

This changes the prompt to:
SGOS#(config ssl)
edit ssl-client ssl_default_client_name

This changes the prompt to:
SGOS#(config ssl ssl_default_client_name)

- subcommandsoption 1: ciphersuite
option 2: exit
option 3: keyring-id keyring_id
option 4: protocol sslv2 | sslv3 | tlsv1 | sslv2v3 | sslv2tlsv1| sslv3tlsv1 |
sslv2v3tlsv1

210

Chapter 3: Privileged Mode Configure Commands

option 5: view
Table 3.102: #(config ssl ssl_default_client_name)
ciphersuite

Configures SSL client cipher suites.

exit

Exits configure ssl ssl-client
ssl_default_client_name mode and
returns to ssl configure mode.

keyring-id

keyring_id

Configures SSL client keyring id.

protocol

sslv2 | sslv3 | tlsv1 |
sslv2v3 | sslv2tlsv1|
sslv3tlsv1 |
sslv2v3tlsv1

Configures SSL client protocol version.

view

Displays the SSL client details.

Examples:
SGOS#(config) ssl
SGOS#(config ssl) edit ssl-client ssl_default_client_name
SGOS#(config ssl ssl-client ssl_default_client_name) ciphersuite
ok
SGOS#(config ssl ssl-client ssl_default_client_name) exit
SGOS#(config ssl) exit
SGOS#(config)

#(config) static-routes
Use this command to set the network path to download the static routes configuration file.
To use static routes on the ProxySG, you must create a routing table and place it on an HTTP server
accessible to the ProxySG. The routing table is a text file that contains a list of IP addresses, subnet
masks, and gateways. When you download a routing table, the table is stored in the device until it is
replaced by downloading a new table.
The routing table is a simple text file containing a list of IP addresses, subnet masks, and gateways. A
sample routing table is illustrated below:
10.63.0.0255.255.0.010.63.158.213
10.64.0.0255.255.0.010.63.158.213
10.65.0.0255.255.0.010.63.158.226

When a routing table is loaded, all requested addresses are compared to the list, and routed based on
the best match.
Once the routing table is created, place it on an HTTP server so it can be downloaded to the device. To
download the routing table to the ProxySG, use the load command.

Syntax
option 1: static-routes no path
option 2: static-routes path url}

211

Blue Coat ProxySG Command Line Interface Reference

Table 3.103: #(config) static-routes
no path
path

Clears the network path location of the
static route table.
url

Sets the network path location of the static
route table to the specified URL.

Example
SGOS#(config) static-routes path 10.25.36.47/files/routes.txt
ok

#(config) streaming
Use this command to configure general streaming settings and Microsoft Windows Media or
RealNetworks Real Media settings.

Syntax
option 1: streaming max-client-bandwidth kbps
option 2: streaming max-gateway-bandwidth kbps
option 3: streaming multicast
sub-option 1: address-range first_address - last_address
sub-option 2: port-range first_port - last_port
sub-option 3: ttl ttl

option 4: streaming no
sub-option 1: max-client-bandwidth
sub-option 2: max-gateway-bandwidth

option 5: streaming quicktime
sub-option 1: http-handoff {disable | enable}
sub-option 2: max-client-bandwidth kbps
sub-option 3: max-connections number
sub-option 4: max-gateway-bandwidth kbps
sub-option 5: no {max-client-bandwidth | max-connections | max-gateway-bandwidth}

option 6: streaming real-media
sub-option 1: http-handoff {disable | enable}
sub-option 2: log-forwarding {disable | enable}
sub-option 3: max-client-bandwidth kbps
sub-option 4: max-connections number
sub-option 5: max-gateway-bandwidth kbps
sub-option 6: multicast {disable | enable}
sub-option 7: no {max-client-bandwidth | max-connections | max-gateway-bandwidth |
refresh-interval}
sub-option 8: refresh-interval hours

212

Chapter 3: Privileged Mode Configure Commands

option 7: streaming windows-media
sub-option 1: asx-rewrite number in_addr cache_proto cache_addr [cache-port]
sub-option 2: broadcast-alias alias url loops date time
sub-option 3: http-handoff {disable | enable}
sub-option 4: live-retransmit {disable | enable}
sub-option 5: log-compatibility {disable | enable}
sub-option 6: log-forwarding {disable | enable}
sub-option 7: max-client-bandwidth kpbs
sub-option 8: max-connections number
sub-option 9: max-fast-bandwidth kpbs
sub-option 10: max-gateway-bandwidth kpbs
sub-option 11: multicast-alias alias url [preload]
sub-option 12: multicast-station name {alias | url} ip port ttl
sub-option 13: no {asx-rewrite number | broadcast-alias alias |
max-client-bandwidth | max-connections | max-gateway-bandwidth | multicast-alias
alias | multicast-station name | refresh-interval | server-auth-type
cache_ip_address | unicast-alias alias}
sub-option 14: refresh-interval hours
sub-option 15: server-auth-type {basic | ntlm} cache_ip_address
sub-option 16: server-thinning {disable | enable}
sub-option 17: unicast-alias alias url
Table 3.104: #(config) streaming
max-client-bandwidth

kbps

Sets the maximum client bandwidth
permitted to kbps.

max-gateway-bandwidth

kbps

Sets the maximum gateway bandwidth
permitted to kbps.

multicast

address-range
first_address-last_addr
ess

The IP address range for the ProxySG's
multicast-station. Default is from
224.2.128.0 and 224.2.255.255.

port-range
first_port-last_port

Port range for the ProxySG's
multicast-station. Default is between 32768
and 65535.

ttl ttl

Time to live value for the multicast-station
on the ProxySG, expressed in hops.
Default is 5; a valid number is between 1
and 255.

max-client-bandwidth

Clears the current maximum client
bandwidth setting.

max-gateway-bandwidth

Clears the current maximum gateway
bandwidth setting.

no

213

Blue Coat ProxySG Command Line Interface Reference

Table 3.104: #(config) streaming (Continued)
quicktime

real-media

214

http-handoff {disable |
enable}

Disables or enables QuickTime HTTP
handoff.

max-client-bandwidth
kbps

Sets the maximum connections allowed.

max-connections number

Sets the maximum client bandwidth
allowed.

max-gateway-bandwidth
kbps

Sets the maximum gateway bandwidth
allowed.

no
{max-client-bandwidth |
max-connections |
max-gateway-bandwidth}

Negates QuickTime parameters.

http-handoff {disable |
enable}

Disables or enables Real Media HTTP
handoff.

log-forwarding {disable
| enable}

Sets Real Media client log forwarding.

max-client-bandwidth
kbps

Limits the total bandwidth used by all
connected clients. Changing the setting to
no max-client-bandwidth uses the
maximum available bandwidth. Zero (0) is
not an accepted value.

max-connections number

Limits the concurrent number of client
connections. Changing the setting to no
max-connections uses the maximum
available bandwidth. Zero (0) is not an
accepted value.

max-gateway-bandwidth
kbps

Limits the total bandwidth used between
the proxy and the gateway. Changing the
setting to no max-gateway-bandwidth,
uses the maximum available bandwidth.
Zero (0) is not an accepted value.

multicast {disable |
enable}

Disables or enables Real Media client
multicast support.

no
{max-client-bandwidth |
max-connections |
max-gateway-bandwidth |
refresh-interval}

Negates Real Media parameters.

refresh-interval hours

Sets the streaming content refresh interval.

Chapter 3: Privileged Mode Configure Commands

Table 3.104: #(config) streaming (Continued)
windows-media

asx-rewrite number
in_addr cache_proto
cache_addr [cache_port]

Provides proxy support for Windows
Player 6.4.
If your environment does not use a Layer 4
switch or WCCP, the ProxySG can operate
as a proxy for Windows Media Player 6.4
clients by rewriting the .asx file (which
links web pages to Windows Media ASF
files) to point to the Windows Media
streaming media cache rather than the
Windows Media server.
number can be any positive number. It
defines the priority of all the asx-rewrite
rules. Smaller numbers indicate higher
priority. in_addr specifies the hostname.
It can have a maximum of one wildcard
character. cache_proto rewrites the
protocol on the ProxySG and can take any
of the following forms:
mmsu (MMS-UDP)
mmst (MMS-TCP)
http (HTTP)
mms (MMS-UDP or MMS-TCP)
cache_addr rewrites the address on the
ProxySG.

215

Blue Coat ProxySG Command Line Interface Reference

Table 3.104: #(config) streaming (Continued)
windows-media,
continued

broadcast-alias alias
url loops date time

Enables scheduled live unicast or multicast
transmission of video-on-demand content.
alias must be unique. url specifies the
address of the video-on-demand stream.
loops specifies the number of times the
stream should be played back. 0 means
forever. date specifies the broadcast alias
starting date. To specify multiple starting
dates, enter the date as a comma-separated
string. date can take any of the following
formats:
yyyy-mm-dd
today
time specifies the broadcast-alias starting
time. To specify multiple starting times
within the same date, enter the time as a
comma-separated string. No spaces are
permitted. time can take any of the
following formats:
hh:mm
midnight, 12am, 1am, 2am, 3am,
4am, 5am, 6am, 7am, 8am, 9am,
10am, 11am, noon, 12pm, 1pm,
2pm, 3pm, 4pm, 5pm, 6pm, 7pm,
8pm, 9pm, 10pm, 11pm.

http-handoff {enable |
disable}

Allows the Windows Media module to
control the HTTP port when Windows
Media streaming content is present. The
default is enabled.

live-retransmit {enable
| disable}

Allows the ProxySG to retransmit dropped
packets sent through MMS-UDP for
unicast. The default is enabled.

log-compatibility
{enable | disable}

When log compatibility is enabled, the
ProxySG generates the same MMS log as
the Windows Media Server. Three fields
are affected when log compatibility is
enabled:
• // c-ip = x-wm-c-ip (client address
derived from client log).
• // c-dns = x-wm-c-dns (client
hostname derived from client log).
• // c-uri-stem = cs-uri (use full
URI instead of just the path).

216

log-forwarding {enable
| disable}

Enables forwarding of the client log to the
origin media server.

max-client-bandwidth
kbps

Sets the maximum client bandwidth
permitted to kbps.

max-connections number

Limits the concurrent number of client
connections. If this variable is set to 0, you
effectively lock out all client connections to
the ProxySG. To allow maximum client
bandwidth, enter streaming
windows-media no
max-connections.

Chapter 3: Privileged Mode Configure Commands

Table 3.104: #(config) streaming (Continued)
windows-media,
continued

max-fast-bandwidth kpbs

Sets the maximum fast start bandwidth
per player.

max-gateway-bandwidth
kbps

Sets the maximum limit, in kilobits per
second (Kbps), for the amount of
bandwidth Windows Media uses to send
requests to its gateway. If this variable is
set to 0, you effectively prevent the
ProxySG from initiating any connections
to the gateway. To allow maximum
gateway bandwidth, enter streaming
windows-media no
max-gateway-bandwidth.

multicast-alias alias
url [preload]

Creates an alias on the ProxySG that
reflects the multicast station on the origin
content server.

multicast-station name
[alias | url] ip port ttl

Enables multicast transmission of
Windows Media content from the
ProxySG. name specifies the name of the
alias. It must be unique. alias can be a
unicast alias, a multicast-alias or a
broadcast alias, as well as a url to a live
stream source. ip is an optional parameter
and specifies the multicast station's IP
address. port specifies the multicast
station's port value address. ttl specifies
the multicast-station's time-to-live value,
expressed in hops (and must be a valid
number between 1 and 255). The default
ttl is 5.

no (see windows-media
no)
refresh-interval hours

Checks the refresh interval for cached
streaming content. hours must be a
floating point number to specify refresh
interval. 0 means always check for
freshness.

server-auth-type {basic
| ntlm}
cache_ip_address

Sets the authentication type of the
ProxySG indicated by
cache_ip_address to BASIC or NTLM.

server-thinning
{disable | enable}

Disables or enables server thinning.

unicast-alias alias url

Creates an alias on the ProxySG that
reflects the content specified by the URL.
When a client requests the alias content,
the ProxySG uses the URL specified in the
unicast-alias command to request the
content from the origin streaming server.

217

Blue Coat ProxySG Command Line Interface Reference

Table 3.104: #(config) streaming (Continued)
windows-media no

asx-rewrite number

Deletes the ASX rewrite rule associated
with number.

broadcast-alias alias

Deletes the broadcast alias rule associated
with alias.

max-client-bandwidth

Negates maximum client bandwidth
settings.

max-connections

Negates maximum connections settings.

max-gateway-bandwidth

Negates maximum gateway bandwidth
settings.

multicast-alias alias

Deletes the multicast alias rule associated
with alias.

multicast-station name

Deletes the multicast station rule
associated with name.

refresh-interval

Sets the current Windows Media refresh
interval to “never refresh.”

server-auth-type
cache_ip_address

Clears the authentication type associated
with cache_ip_address.

unicast-alias alias

Deletes the unicast alias rule associated
with alias. The name of the alias, such as
“welcome1” that is created on the ProxySG
and reflects the content specified by the
URL. The protocol is specified by the URL
if the protocol is mmst, mmsu, or http. If
the protocol is mms, the same protocol as
the client is used.

Example
SGOS#(config) streaming windows-media http-handoff enable
ok
SGOS#(config) streaming windows-media live-retransmit disable
ok
SGOS#(config) streaming windows-media log-forwarding disable
ok
SGOS#(config) streaming windows-media max-connections 1600
ok
SGOS#(config) streaming windows-media no max-connections
ok

#(config) tcp-ip
Use the following commands to configure your TCP-IP settings.

Syntax
option 1: tcp-ip icmp-bcast-echo {disable | enable}
option 2: tcp-ip icmp-tstamp-echo {disable | enable}

218

Chapter 3: Privileged Mode Configure Commands

option 3: tcp-ip ip-forwarding {disable | enable}
option 4: tcp-ip pmtu-discovery {disable | enable | expire-period seconds |
probe-interval seconds}
option 5: tcp-ip rfc-1323 {disable | enable}
option 6: tcp-ip tcp-newreno {disable | enable}
option 7: tcp-ip window-size window_size
Table 3.105: #(config) tcp-ip
icmp-bcast-echo

disable | enable

Enables or disables ICMP broadcast echo
responses.

icmp-tstamp-echo

disable | enable

Enables or disables ICMP timestamp echo
responses.

ip-forwarding

disable | enable

Enables or disables IP-forwarding.

pmtu-discovery

disable | enable |
expire-period seconds |
probe-interval seconds

Enables or disables Path MTU Discovery,
and configures the PMTU expiration
period and probe interval. The default is
disabled.

rfc-1323

disable | enable

Enables or disables RFC-1323 support
(satellite communications).

tcp-newreno

disable | enable

Enables or disables TCP NewReno support
(improved fast recovery).

window-size

window_size

Specifies the TCP window size for satellite
communications.

Example
SGOS#(config) tcp-ip ip-forwarding enable
ok
SGOS#(config) tcp-ip rfc-1323 enable
ok

#(config) tcp-rtt
Use this command to configure the number of TCP round trip time ticks.

Syntax
tcp-rtt num_500ms_ticks
Table 3.106: #(config) tcp-rtt
num_500ms_ticks

Indicates the default TCP Round Trip Time
in ticks.

Example
SGOS#(config) tcp-rtt 500
ok

219

Blue Coat ProxySG Command Line Interface Reference

#(config) tcp-rtt-use
Use this command to enable or disable the default TCP Round Trip Time.

Syntax
tcp-rtt-use {disable | enable}
Table 3.107: #(config) tcp-rtt-use
disable

Disables using fixed RTT.

enable

Enables using fixed RTT.

Example
SGOS#(config) tcp-rtt-use enable
ok

#(config) telnet-management
Enables or disables the ability to configure SSHD through Telnet.

Syntax
option 1: telnet-management allow-sshd-config
option 2: telnet-management deny-sshd-config
Table 3.108: #(config) telnet-management
allow-sshd-config

Enables configuring of SSHD through
Telnet.

deny-sshd-config

Disables configuring of SSHD through
Telnet.

Example
SGOS#(config) telnet allow-sshd-config
ok

#(config) timezone
Use this command to set the local time zone on the ProxySG.

Syntax
timezone timezone_number
Table 3.109: #(config) timezone
timezone_number

220

Enables you to set the local time zone. (Use
(config)show timezones to display a
list of supported timezones.)

Chapter 3: Privileged Mode Configure Commands

Example
SGOS#(config) timezone 3
ok

#(config) upgrade-path
Use this command to specify the network path to download system software.

Syntax
upgrade-path url
Table 3.110: #(config) upgrade-path
url

Indicates the network path to use to
download ProxySG system software.

Example
SGOS#(config) upgrade-path 10.25.36.47
ok

#(config) virtual-ip
This command allows you to configure virtual IP addresses.

Syntax
option 1: virtual-ip address ip_address
option 2: virtual-ip clear
option 3: virtual-ip no address ip_address
Table 3.111: #(config) virtual-ip
address

ip_address

clear
no address

Specifies the virtual IP to add.
Removes all virtual IP addresses.

ip_address

Removes the specified virtual IP from the
list.

Example
SGOS#(config) virtual-ip address 10.25.36.47
ok

#(config) wccp
The ProxySG can be configured to participate in a WCCP (Web Cache Control Protocol) scheme, where
a WCCP-capable router collaborates with a set of WCCP-configured ProxySG Appliances to service
requests. WCCP is a Cisco-developed protocol. For more information about WCCP, refer to the Blue
Coat Configuration and Management Guide.

221

Blue Coat ProxySG Command Line Interface Reference

Once you have created the WCCP configuration file, place the file on an HTTP server so it can be
downloaded to the ProxySG. To download the WCCP configuration to the ProxySG, use the load
command.

Syntax
option 1: wccp disable
option 2: wccp enable
option 3: wccp no path
option 4: wccp path url
Table 3.112: #(config) wccp
disable

Disables WCCP.

enable

Enables WCCP.

no path

Negates certain WCCP settings.

path

url

Specifies the network path from which to
download WCCP settings.

Example
SGOS#(config) wccp path 10.25.36.47/files/wccp.txt
ok

222

Document Path: ["125-blue-coat-instruction-reference-guide-proxysg.pdf"]

e-Highlighter

Click to send permalink to address bar, or right-click to copy permalink.

Un-highlight all Un-highlight selectionu Highlight selectionh