Command-Line Reference

This section describes all GigaVUE‑OS commands. The commands are organized alphabetically.

For a summary of all the commands and their syntax, refer to Command Line Summary.

Refer to the top-level commands as follows:

Command Description

aaa

Configures authentication, authorization, and accounting settings.

apps

Enables access to Gigamon Applications, such as Application Session Filtering (ASF), GTP backup, GTP whitelisting, Hardware Security Module (HSM), HSM group, inline SSL decryption, keystore, NetFlow, SIP whitelisting, and Passive SSL decryption. GigaSMART applications are not supported on GigaVUE TA Series.

banner

Sets a system login banner.

bond

Configures bonded interface settings.

boot

Configures system boot parameters.

card (GigaVUE H Series)

Configures a line card or module.

On GigaVUE TA Series nodes, use the card (GigaVUE TA Series) command to enable additional ports.

chassis

Configures the GigaVUE H Series chassis.

clear

Resets statistics or clears caches.

cli

Configures CLI shell options.

clock

Sets the system clock or timezone.

cluster

Configures a cluster of connected GigaVUE‑OS nodes.

configuration

Manages configuration files.

configure

Enters Configure mode.

coreboot

Upgrades the BIOS image on GigaVUE-TA100, GigaVUE-TA100-CXP, GigaVUE‑HC1, and GigaVUE‑HC3.

crypto

Manages X.509 certificates for the GigaVUE H Series node’s Web server.

debug

Generates a dump file for use in debugging issues with Gigamon Technical Support.

disable

Exits Enable mode and returns to Standard mode.

email

Configures email and event notification through email.

enable

Enters Enable mode.

exit

Exits Configure mode and returns to Enable mode or logs out of the CLI.

fabric advanced-hash

Configures advanced hashing parameters on stack GigaStreams and gsgroups.

file

Manages TCP and debug dump files on disk.

filter-template

Configures flexible filter templates on GigaVUE‑HC3 and GigaVUE-TA100.

gigasmart

Configures a stack port interface to provide Internet connectivity for a GigaSMART card or module.

gigastream

Configures a GigaStream—a group of ports acting as a single addressable tool port destination or stack-link.

gsgroup

Configures a GigaSMART group consisting of one or more GigaSMART engine ports. GigaSMART applications are not supported on GigaVUE TA Series.

gsop

Configures a GigaSMART operation consisting of one or more advanced processing applications. GigaSMART applications are not supported on GigaVUE TA Series.

gsparams

Configures GigaSMART parameters. GigaSMART applications are not supported on GigaVUE TA Series.

gta-profile

Configures a Control and User Plane Seperation (CUPS) gta profile on a Control Processing Plane for routing the Gigamon Transport Agent (GTA) packets.

halt

Shuts down the system without powering it off.

hb-profile

Configures a heartbeat profile on GigaVUE HC Series nodes.

header-strip

Configure the header stripping protocol for a chassis.

help

Views a description of the interactive help system.

hostname

Specifies the system's hostname. The hostname appears in the system prompt and in SNMP traps.

ib-pathway

Configures the Resilient Inline Arrangement feature.

image

Manages system software images.

inline-network

Configures an inline network on GigaVUE HC Series nodes.

inline-network-group

Configures an inline network group on GigaVUE HC Series nodes.

inline-serial

Configures an inline tool series on GigaVUE HC Series nodes.

inline-tool

Configures an inline tool on GigaVUE HC Series nodes.

inline-tool-group

Configures an inline tool group on GigaVUE HC Series nodes.

interface

Configures network interfaces.

ip

Configures IP settings for the eth0 Mgmt port.

ip interface

Configures an IP interface to be used for GigaSMART encapsulation/decapsulation operations. This command is not supported on GigaVUE TA Series nodes.

ipv6

Configures IPv6 settings for the eth0 Mgmt port.

job

Configures scheduled jobs.

ldap

Configures LDAP server settings for authentication.

license

Activates features using license keys. Licensing is used for GigaSMART, Port, or Advanced Features License.

logging

Configures event logging.

map

Configures maps and map rules to manage GigaVUE traffic distribution.

map-group

Configures map groups for GTP forward list selective forwarding - forward (formerly whitelist)ing and GTP flow sampling.

map-passall

Creates a passall map to send all traffic on a network port to a tool port irrespective of the other packet distribution in place on the port.

amap-scollector

Configures shared collector map parameters.

map-template

Creates a map template.

nhb-profile

Configures a negative heartbeat profile on GigaVUE HC Series nodes.

no

Deletes or clears certain configuration options.

notifications

Configures notification settings.

ntp

Enables and disables the use of NTP, as well as adds NTP servers.

ntpdate

Sets system clock once from a remote server using NTP.

onie

Reboots a Certified Traffic Aggregation White Box (white box) into Open Network Install Environment (ONIE) modes. This command is only available on white boxes where GigaVUE‑OS is installed.

ping

Sends ICMP echo requests to a specified host.

ping6

Sends ICMPv6 echo requests to a specified host.

pld

Upgrades programmable logic devices (PLDs) on GigaVUE‑HC3 nodes.

policy

Configures an active visibility policy.

port

Configures port type, parameters, and filters.

port-group

Creates a group of ports.

port-pair

Configures a port-pair on a pair of network ports within the same GigaVUE H Series node. A port-pair is a bidirectional connection in which traffic arriving on one port in the pair is transmitted out the other (and vice-versa) as a passthrough TAP.

ptp

Enables and disables the use of PTP.

radius-server

Configures RADIUS server settings for authentication.

redundancy-profile

Configures an inline redundancy profile on GigaVUE HC Series nodes.

reload (reboot)

Reboots or shuts down the node.

reset

Resets specified portions of the system configuration to their factory states.

serial

Sets options for the serial console port.

sfp

Reserved for future use.

show

Displays configuration and status information for GigaVUE H Series settings and entities.

sleep

Sleeps for a specified number of seconds.

snmp-server

Configures SNMP settings, including the local SNMP server, notification events, and notification destinations.

spine-link

Configures spine links in a cluster with a leaf and spine architecture.

ssh

Enables and disables SSH access, as well as manages settings.

stack-link

Configures a stack-link between two GigaVUE H Series nodes in a cluster. Stack-links are used to carry data traffic between nodes in a GigaVUE H Series cluster.

system

Changes system settings.

system-health

Configures system health behaviors.

tacacs-server

Configures TACACS+ server settings for authentication.

terminal

Sets terminal parameters, including width and length.

timestamp

Configures the timestamp source leader in a bidirectional clock relationship (formerly master). This command is not supported on GigaVUE TA Series nodes.

tool-mirror

Configures a tool-mirror connection between two tool ports. A tool-mirror connection sends all packets arriving on one tool port to a second tool port on the same node.

traceroute

Traces the route packets take to a destination.

tunnel

Configures a circuit tunnel between two clusters.

tunnel-endpoint

Configures a tunnel endpoint, which is a destination for load balanced traffic from a L2GRE encapsulation tunnel.

uboot

Installs new uboot software.

username

Manages user accounts.

vport

Configures a virtual port. This command is not supported on GigaVUE TA Series nodes.

web

Configures the Web server used for H-VUE GUI support on the GigaVUE H Series node.

write

Saves the running configuration to persistent storage.