For feedback and comments:
documentation.feedback@alcatel-lucent.com

Table of Contents Previous Next Index PDF


Configuration Commands
Generic Commands
description
Syntax
description string
no description
Context
config>filter>dhcp-filter
config>filter>ip-filter
config>filter>ipv6-filter
config>filter>ip-filter>entry
config>filter>ip-filter>entry
config>filter>ipv6-filter>entry
config>filter>log
config>filter>mac-filter
config>filter>mac-filter>entry
config>filter>redirect-policy
config>filter>redirect-policy>destination
config>filter>match-list>ip-prefix-list
config>filter>match-list>ip-filter
config>filter>match-list>port-list
Description
This command creates a text description stored in the configuration file for a configuration context.
The description command associates a text string with a configuration context to help identify the context in the configuration file.
The no form of the command removes any description string from the context.
Default
none
Parameters
string
The description character string. Allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
 
 
Global Filter Commands
dhcp-filter
Syntax
dhcp-filter filter-id [create]
no dhcp-filter filter-id
Context
config>filter
Description
This command configures the identification number of a DHCP filter.
Parameters
filter-id
Specifies the DHCP filter policy ID number.
Values
create
Keyword required when first creating the configuration context. Once the context is created, one can navigate into the context without the create keyword.
filter-name
A string of up to 64 characters uniquely identifying this filter policy.
ip-filter
Syntax
ip-filter filter-id [create]
ip-filter {filter-id | filter-name}
no ip-filter filter-id
Context
config>filter
Description
This command creates a configuration context for an IP (v4) filter policy.
The no form of the command deletes the IP filter policy. A filter policy cannot be deleted until it is removed from all objects where it is applied.
Parameters
filter-id
Specifies the IP filter policy ID number.
Values
create
Keyword required when first creating the configuration context. Once the context is created, one can navigate into the context without the create keyword.
filter-name
A string of up to 64 characters uniquely identifying this filter policy.
ipv6-filter
Syntax
ipv6-filter filter-id [create]
ip-filter {filter-id | filter-name}
no ipv6-filter ipv6-filter-id
Context
config>filter
Description
This command creates a configuration context for an IP (v6) filter policy.
The no form of the command deletes the IP filter policy. A filter policy cannot be deleted until it is removed from all objects where it is applied.
Parameters
filter-id
specifies the IPv6 filter policy ID number.
Values
create
Keyword required when first creating the configuration context. Once the context is created, one can navigate into the context without the create keyword.
filter-name
A string of up to 64 characters uniquely identifying this IPv6 filter policy.
system-filter
Syntax
system-filter
Context
config>filter
Description
This command enables the context to activate system filter policies.
Parameters
none
mac-filter
Syntax
mac-filter filter-id [create]
mac-filter {filter-id | filter-name}
no mac-filter filter-id
Context
config>filter
Description
This command enables the context for a MAC filter policy.
The no form of the command deletes the mac-filter policy. A filter policy cannot be deleted until it is removed from all objects where it is applied.
Parameters
filter-id
The MAC filter policy ID number.
Values
create
Keyword required when first creating the configuration context. Once the context is created, one can navigate into the context without the create keyword.
filter-name
A string of up to 64 characters uniquely identifying this filter policy.
redirect-policy
Syntax
[no] redirect-policy redirect-policy-name
Context
config>filter
Description
This command configures redirect policies.
The no form of the command removes the redirect policy from the filter configuration only if the policy is not referenced in a filter and the filter is not in use (applied to a service or network interface).
Default
none
Parameters
redirect-policy-name
Specifies the redirect policy name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. There is no limit to the number of redirect policies that can be configured.
log
Syntax
log log-id [create]
no log
Context
config>filter
Description
This command enables the context to create a filter log policy.
The no form of the command deletes the filter log ID. The log cannot be deleted if there are filter entries configured to write to the log. All filter entry logging associations need to be removed before the log can be deleted.
Special Cases
Filter log 101
Filter log 101 is the default log and is automatically created by the system. Filter log 101 is always a memory filter log and cannot be changed to a Syslog filter log. The log size defaults to 1000 entries. The number of entries and wrap-around behavior can be modified.
Default
log 101
Parameters
log-id
The filter log ID destination expressed as a decimal integer.
Values
 
DHCP Filter Commands
action
Syntax
action {bypass-host-creation}
action drop
no action
Context
config>filter>dhcp-filter>entry
Description
This command specifies the action to take on DHCP host creation when the filter entry matches.
The no form of the command reverts to the default wherein the host creation proceeds as normal
Default
no action
Parameters
bypass-host-creation
Specifies that the host creation is bypassed.
drop
Specifies the DHCP message is dropped.
option
Syntax
option dhcp-option-number {present | absent}
option dhcp-option-number match hex hex-string [exact] [invert-match]
option dhcp-option-number match string ascii-string [exact] [invert-match]
no option
Context
config>filter>dhcp-filter>entry
Description
This command configures the action to take on DHCP host creation when the filter entry matches.
The no form of the command reverts to the default.
Parameters
dhcp-option-number
 
Values
present
Specifies that the related DHCP option must be present.
absent
Specifies that the related DHCP option must be absent.
match hex hex-string
The option must (partially) match a specified hex string.
Values
match string ascii-string
The option must (partially) match a specified ASCII string.
Values
exact
This option requires an exact match of a hex or ascii string.
invert-match
Requires the option not to (partially) match.
Filter Log Commands
destination
Syntax
destination memory num-entries
destination syslog syslog-id
no destination
Context
config>filter>log
Description
This command configures the destination for filter log entries for the filter log ID.
Filter logs can be sent to either memory (memory) or to an existing Syslog server definition (syslog).
If the filter log destination is memory, the maximum number of entries in the log must be specified.
The no form of the command deletes the filter log association.
Default
no destination
Parameters
memory num-entries
Specifies the destination of the filter log ID is a memory log. The num-entries value is the maximum number of entries in the filter log expressed as a decimal integer.
Values
syslog syslog-id
Specifies the destination of the filter log ID is a Syslog server. The syslog-id parameter is the number of the Syslog server definition.
Values
shutdown
Syntax
[no] shutdown
Context
config>filter>log
config>filter>log>summary
Administratively enables/disabled (AdminUp/AdminDown) an entity. Downing an entity does not change, reset or remove any configuration settings or statistics. Many objects must be shutdown before they may be deleted.
The shutdown command administratively downs an entity. Administratively downing an entity changes the operational state of the entity to down.
Unlike other commands and parameters where the default state will not be indicated in the configuration file, shutdown and no shutdown are always indicated in system generated configuration files.
The no form of the command puts an entity into the administratively enabled state.
Default
no shutdown
summary
Syntax
summary
Context
config>filter>log
Description
This command enables the context to configure log summarization. These settings will only be taken into account when syslog is the log destination. Note that summary settings will only be taken into account in case the log destination is syslog.
Parameters
none
summary-crit
Syntax
summary-crit dst-addr
summary-crit src-addr
no summary-crit
Context
config>filter>log>summary
Description
This command defines the the key of the index of the minitable. If key information is changed while summary is in no shutdown, the filter summary minitable is flushed and recreated with different key information. Log packets received during the reconfiguration time will be handled as if summary was not active.
The no form of the command reverts to the default parameter.
Default
dst-addr
Parameters
dst-addr
Specifies that received log packets are summarized based on the destination IP, IPv6, or MAC address.
src-addr
Specifies that received log packets are summarized based on the source IP, IPv6 or MAC address.
wrap-around
Syntax
[no] wrap-around
Context
config>filter>log
Description
This command configures a memory filter log to log until full or to store the most recent log entries (circular buffer).
Specifying wrap-around configures the memory filter log to store the most recent filter log entries (circular buffer). When the log is full, the oldest filter log entries are overwritten with new entries.
The no form of the command configures the memory filter log to accept filter log entries until full. When the memory filter log is full, filter logging for the log filter ID ceases.
Default
wrap-around
 
ACL Filter Policy Commands
default-action
Syntax
default-action {drop | forward}
Context
config>filter>ip-filter
config>filter>ipv6-filter
config>filter>mac-filter
Description
This command defines default action to be applied to packets not matching any entry in this ACL filter policy or to packets for that match a PBR filter entry for which the PBR target is down and pbr-down-action per-entry override is set to filter-default-action.
The options are the following:
drop – default action is to drop a packet.
forward – default action is to forward a packet.
Default
drop
chain-to-system-filter
Syntax
chain-to-system-filter
no chain-to-system-filter
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command chains this filter to a currently active system filter. When the filter is chained to the system filter, the system filter rules are executed first, and the filter rules are only evaluated if no match on the system filter was found.
The no form of the command detaches this filter from the system filter.
Default
no chain-to-system-filter
Operational note:
If no system filter is currently active, the command has no effect.
ip
Syntax
ip filter-id
no ip filter-id
Context
config>filter>system-filter
Description
This command activates an IPv4 system filter policy. Once activated, all IP ACL filter policies that chain to the system filter (config filter ip-filter chain-to-system-filter) will automatically execute system filter policy rules first.
The no form of the command deactivates the system filter policy.
Default
None of the IPv4 system filters is available by default.
Parameters
filter-id
An existing IP filter policy with scope system.
Values
ipv6
Syntax
ipv6 filter-id
no ipv6 filter-id
Context
config>filter>system-filter
Description
This command activates an IPv6 system filter policy. Once activated, all IPv6 ACL filter policies that chain to the system filter (config filter ipv6-filter chain-to-system-filter) will automatically execute system filter policy rules first.
The no form of the command deactivates the system filter policy.
Default
None of the IPv6 system filters is available by default.
Parameters
filter-id
An existing IPv6 filter policy with scope system.
Values
 
embed-filter
Syntax
embed-filter filter-id [offset offset] [{active | inactive}]
embed-filter open-flow ofs-name [{system | service {service-id | service-name} | sap sap-id}] [offset offset] [{active | inactive}]
embed-filter open-flow ofs-name system [offset offset] [{active | inactive}]
embed-filter open-flow ofs-name service {service-id | service-name} [offset offset] [{active | inactive}]
embed-filter open-flow ofs-name sap sap-id} [offset offset] [{active | inactive}]
no embed-filter filter-id
no embed-filter open-flow ofs-name [{system | service {service-id | service-name} | sap sap-id}]
no embed-filter open-flow ofs-name service {service-id | service-name}
no embed-filter open-flow ofs-name sap sap-id}
no embed-filter open-flow ofs-name system
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command embeds a previously defined IPv4, or IPv6 embedded filter policy or a Hybrid OpenFlow switch instance into this exclusive, template or system filter policy at the specified offset value.
The embed-filter open-flow ofs-name form of this command enables OpenFlow (OF) in GRT either by embedding the specified OpenFlow switch (OFS) instance with switch-defined-cookie disabled, or by embedding rules with sros-cookie:type “grt-cookie”, value 0 from the specified OFS instance with switch-defined-cookie enabled. The embedding filter can only be deployed in GRT context or be unassigned.
The embed-filter open-flow ofs-name system form of this command enables OF in system filters by embedding rules with sros-cookie:type “system-cookie”, value 0 from the specified OFS instance with switch-defined-cookie enabled. The embedding filter can only be of scope system.
The embed-filter open-flow ofs-name service {service-id | service-name} form of this command enables OF in VPRN/VPLS filters by embedding rules with sros-cookie:type “service-cookie”, value service-id from the specified OFS instance with switch-defined-cookie enabled – per service rules. The embedding filter can only be deployed in the specified VPRN/VPLS service. Note that a single VPLS service can only support OF rules per SAP or per service.
The embed-filter open-flow ofs-name sap sap-id form of this command enables OF in VPLS SAP filters by embedding rules with sros-cookie:type “service-cookie”, value service-id and flow match conditions specifying the sap-id from the specified OFS instance with switch-defined-cookie enabled – per SAP OF rules. The embedding filter must be of type exclusive and can only be deployed on the specified SAP in the context of the specified VPLS service. Note that a single VPLS service can only support OF rules per SAP or per service.
The no embed-filter filter-id form of this command removes the embedding from this filter policy.
The no embed-filter open-flow ofs-name form of this command removes the OF embedding for the GRT context.
Please see the description of embedded filter policies in this guide for further operational details.
Default
No embedded filter policies are included in a filter policy by default
Parameters
filter-id
Specifies a previously defined embedded filter policy.
open-flow ofs-name
Specifies the name of the currently configured Hybrid OpenFlow Switch (OFS) instance.
Not including the system, service or sap parameters will specify OF in a GRT instance context by default. This allows embedding of OF rules into filters deployed in GRT instances from OFS with switch-defined-cookie disabled, or embedding rules from OFS with switch-defined-cookie enabled, when the FlowTable cookie encodes sros-cookie:type “grt-cookie”.
system
Used for OF control of system filters. Allows embedding of OF rules into system filters from OFS with switch-defined-cookie enabled. Only the rules with cookie value encoding “system-cookie” are embedded.
service {service-id | service-name}
Used for OF control of VPRN or VPLS services. Allows embedding of OF rules into a VPRN or VPLS access or network filters. Only the rules with cookie value encoding the specified service ID are embedded into the filter. The embedding filter can only be deployed in the context of the specified service.
service-id — Specifies an existing 7x50 VPRN or VPLS service ID that the embedding filter can be used for.
service-name — Specifies an existing 7x50 VPRN or VPLS service name that the embedding filter can be used for.
sap sap-id
Used for OF control of VPLS services when a PortID and VLAN ID match is required. Allows embedding of OF rules with a PortID and VLAN ID match into excusive VPLS SAP filters. Only the rules with cookie value encoding the VPLS service, and flow table match encoding the specified SAP are embedded into the filter. The embedding filter can only be deployed in the context of the specified SAP.
sap-id — Specifies an existing 7x50 SAP that the embedding filter can be used for.
offset
An embedded filter entry X will have an entry X + offset in the embedding filter.
Values
active
Specifies that embedded filter entries are to be included in this embedding filter policy and activated on applicable line cards – default if no keyword is specified and omitted in info command (but not info detail), or when saving configuration.
inactive
Specifies that no embedded filter policy entries are to be included in this embedded filter policy. The embedding is configured but will not do anything.
filter-name
Syntax
filter-name filter-name
Context
config>filter>ip-filter
config>filter>ipv6>filter
config>filter>mac-filter
Description
This command configures filter-name attribute of a given filter. filter-name, when configured, can be used instead of filter ID to reference the given policy in the CLI.
Default
no filter-name
Parameters
filter-name
A string of up to 64 characters uniquely identifying this filter policy.
The following restrictions apply to the filter-name:
– Policy names may not begin with a number (0-9).
– Policy names may not begin with the underscore “_” character (e.g. _myPolicy). Names that start with underscore are reserved for system generated names.
– “fSpec-x” (where x is any number) cannot be used as a user defined filter name.
scope
Syntax
scope {exclusive | template | embedded | system}
no scope
Context
config>filter>ip-filter
config>filter>ipv6-filter
config>filter>mac-filter
Description
This command configures the filter policy scope as exclusive, template, embedded or system.
The scope of the policy cannot be changed when:
 
the scope is template and the policy is applied to one or more services or network interfaces
 
the scope is embedded and the policy is embedded by another policy
Changing the scope to/from system is only allowed when a policy is not active and the policy has no entries configured.
The no form of the command sets the scope of the policy to the default of template.
Default
template
Parameters
exclusive
When the scope of a policy is defined as exclusive, the policy can only be applied to a single entity. Attempting to assign the policy to a second entity will result in an error message.
template
When the scope of a policy is defined as template, the policy can be applied to multiple entities.
embedded
When the scope of a policy is defined as embedded, the policy cannot be applied directly. The policy defines embedded filter rules, which are embedded by other exclusive/template/system filter policies. The embedded scope is supported for IP and IPv6 filter policies only.
system
When the scope of a policy is defined as system, the policy defines system-wide filter rules. To apply system policy rules, activate system filter and chain exclusive/template ACL filter policy to the system filter. The system scope is supported for IP and IPv6 filter policies only.
shared-radius-filter-wmark
Syntax
shared-radius-filter-wmark low low-watermark high high-watermark
no shared-radius-filter-wmark
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command configures the low and high watermark for the number of RADIUS shared filters reporting
Parameters
low low-watermark
Specifies the utilization of the filter ranges for filter entry insertion, at which a table full alarm will be raised by the agent.
Values
high high-watermark
Specifies the utilization of the filter ranges for filter entry insertion, at which a table full alarm will be cleared by the agent.
Values
sub-insert-credit-control
Syntax
sub-insert-credit-control start-entry entry-id count count
no sub-insert-credit-control
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command inserts point information for credit control for the filter.
The no form of the command reverts to the default.
Default
none
Parameters
entry entry-id
Identifies a filter on this system.
Values
count count
Specifies the count.
Values
sub-insert-radius
Syntax
sub-insert-radius start-entry entry-id count count
no sub-insert-radius
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command insert point information for RADIUS for the filter.
The no form of the command reverts to the default.
Default
none
Parameters
entry entry-id
Specifies at what place the filter entries received from RADIUS will be inserted in the filter.
Values
count count
Specifies the count.
Values
sub-insert-shared-pccrule
Syntax
sub-insert-shared-pccrule start-entry entry-id count count
no sub-insert-shared-pccrule
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command defines the range of filter and QoS policy entries that are reserved for shared entries received in Flow-Information AVP via Gx interface (PCC rules – Policy and Charging Control). The no version of this command disables the insertion, which will result in a failure of PCC rule installation.
Default
no sub-insert-shared-pccrule
Parameters
start-entry entry-id
Specifies the lowest entry in the range.
Values
count count
Specifies the number of entries in the range.
Values
sub-insert-shared-radius
Syntax
sub-insert-shared-radius start-entry entry-id count count
no sub-insert-shared-radius
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command configures the insert point for shared host rules from RADIUS.
entry entry-id
Identifies a filter on this system.
Values
count count
Specifies the count.
Values
 
sub-insert-wmark
Syntax
sub-insert-wmark low low-watermark high high-watermark
no sub-insert-wmark
Context
config>filter>ip-filter
config>filter>ipv6-filter
Description
This command configures the low and high watermark percentage for inserted filter entry usage reporting.
The no form of the command reverts to the default.
Default
none
Parameters
low low-watermark
Specifies the utilization of the filter ranges for filter entry insertion, at which a table full alarm will be cleared by the agent.
Values
high high-watermark
Specifies the utilization of the filter ranges for filter entry insertion, at which a table full alarm will be raised by the agent.
Values
 
type
Syntax
type filter-type
Context
config>filter>mac-filter
Description
This command configures the type of mac-filter as normal, ISID or VID types.
Default
normal
Parameters
filter-type
Specifies which type of entries this MAC filter can contain.
Values
normal — Regular match criteria are allowed; ISID or VID filter match criteria not allowed.
isid — Only ISID match criteria are allowed.
vid — On.y VID match criteria are allowed on ethernet_II frame types.
 
General Filter Entry Commands
entry
Syntax
entry entry-id [time-range time-range-name] [create]
no entry entry-id
Context
config>filter>dhcp-filter
config>filter>ip-filter
config>filter>ipv6-filter
config>filter>mac-filter
Description
This command creates or edits an IP (v4), IPv6, or MAC filter entry. Multiple entries can be created using unique entry-id numbers within the filter. Entries must be sequenced from most to least explicit.
An entry may not have any match criteria defined (in which case, everything matches) but must have at least the keyword action for it to be considered complete. Entries without the action keyword will be considered incomplete and hence will be rendered inactive.
The no form of the command removes the specified entry from the filter. Entries removed from the filter are immidately removed from all services or network ports where that filter is applied.
Default
none
Parameters
entry-id
An entry-id uniquely identifies a match criteria and the corresponding action. It is recommended that multiple entries be given entry-ids in staggered increments. This allows users to insert a new entry in an existing policy without requiring renumbering of all the existing entries.
Values
time-range time-range-name
Specifies the time range name to be associated with this filter entry up to 32 characters in length. The time-range name must already exist in the config>system>cron context.
create
Keyword required when first creating the configuration context. Once the context is created, one can navigate into the context without the create keyword.
action
Syntax
action
no action
Context
config>filter>ip-filter>entry
config>filter>ipv6-filter>entry
config>filter>mac-filter>entry
Description
This command enters the context to configure ac action to be performed on packets matching this filter entry. An ACL filter entry remains inactive (is not programmed in hardware) until a specific action is configured for that entry.
The no form of this command removes the specific action configured in the context of action command.
Default
no action
log
Syntax
log log-id
no log
Context
config>filter>ip-filter>entry
config>filter>ipv6-filter>entry
config>filter>mac-filter>entry
Description
This command creates the context to enable filter logging for a filter entry and specifies the destination filter log ID.
The filter log ID must exist before a filter entry can be enabled to use the filter log ID.
The no form of the command disables logging for the filter entry.
Default
no log
Parameters
log-id
The filter log ID destination expressed as a decimal integer.
Values
pbr-down-action-override
Syntax
pbr-down-action-override
no pbr-down-action-override
Context
config>filter>ip-filter>entry
config>filter>mac-filter>entry
Description
This command allows overriding the default action that is applied for entries with PBR/PBF action defined, when the PBR/PBF target is down.
The no form of the command preserves default behavior when PBR/PBF target is down.
Default
no pbr-down-action-override
Parameters
drop
Packets matching the entry will be dropped if PBR/PBF target is down.
forward
Packets matching the entry will be forwarded if PBR/PBF target is down.
filter-default-action
Packets matching the entry will be processed as per default-action configuration for this filter if PBR/PBF target is down.
 
IP (v4/v6) Filter Entry Commands
action (IPv4)
Syntax
For IPv4:
drop
drop packet-length {{lt | eq | gt} packet-length-value | range packet-length-value packet-length-value}
drop ttl {{lt | eq | gt} ttl-value | range ttl-value ttl-value}
forward
forward esi esi sf-ip ip-address vas-interface interface-name router {router-instance | service-name service-name}
forward esi esi service-id vpls-service-id
forward lsp lsp-name
forward next-hop [indirect] ip-address
forward next-hop [indirect] ip-address router {router-instance | service-name service-name}
forward next-hop interface ip-int-name
forward redirect-policy policy-name
forward router {router-instance | service-name service-name}]
forward sap sap-id
forward sdp sdp-id:vc-id
gtp-local-breakout
http-redirect rdr-url-string [allow-radius-override]
nat [nat-policy nat-policy-name]
reassemble
Context
config>filter>ip-filter>entry
config>filter>ip-filter>entry>action
Description
The action command (under the config>filter>ip-filter context) sets the context for specific action commands to be performed (under the config>filter>ip-filter>action context) on packets matching this filter entry.
The following commands are available under the config>filter>ip-filter>entry>action context:
drop – A packet matching the entry will be dropped.
drop packet-length – A packet matching the entry will be dropped only if “Total Length” field in the packet’s IPv4 header meets the configured condition.
drop ttl – A packet matching the entry will be dropped only if “Time-to-live” field in the packet’s IPv4 header meets the configured condition.
forward – A packet matching the entry will be forwarded using regular routing.
forward esi service-id - A packet matching the entry will be forwarded to ESI identified first appliance in Nuage service chain using EVPN-resolved VXLAN tunnel in the specified VPLS service.
forward esi sf-ip vas-interface router - A packet matching the entry will be forwarded to ESI/SF-IP identified first appliance in Nuage service chain using EVPN-resolved VXLAN tunnel over the configured VAS interface in the specified VPRN service.
forward lsp – A packet matching the entry will be forwarded using the specified lsp.
forward next-hop – A packet matching the entry will be forwarded in the routing context of the incoming interface using direct or indirect IP address in the routing lookup.
forward next-hop router – A packet matching the entry will be forwarded in the configured routing context using direct or indirect IP address in the routing lookup.
forward next-hop interface – A packet matching the entry will be forwarded using the configured local interface.
forward redirect-policy – A packet matching the entry will be forwarded using forward next-hop or forward next-hop router and the IP address of destination selected by the configured redirect policy. If no destination is selected, packets are subject to action forward.
forward router – A packet matching the entry will be routed in the configured routing instance and not in the incoming interface routing instance.
forward sap – A packet matching the entry will be forwarded using the configured sap.
forward sdp – A packet matching the entry will be forwarded using the configured SDP.
gtp-local-breakout – A packet matching the entry will be forwarded to NAT instead of being GTP tunneled to mobile operator’s PGW or GGSN.
http-redirect – An HTTP GET packet matching an entry is forwarded to CPM for HTTP captive portal processing
nat – A packet matching the entry will be forwarded to NAT
reassemble – A packets matching the entry will be forwarded to the reassembly function
Default
no specific action is configured by default.
Parameters
esi
Specifies a 10-Byte Ethernet Segment Identifier.
ip-address
Specifies the IPv4 address of a direct or indirect next-hop to which to forward matching packets.
ip-int-name
Specifies the name of an egress IP interface where matching packets will be forwarded from. This parameter is only valid for unnumbered point-to-point interfaces. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
interface-name
Specifies the name of an egress r-VPLS IP interface used to forward the packets using ESI redirect for VPRN/IES service.
lsp-name
Specifies an existing RSVP-TE or MPLS-TP LSP that supports LSP redirect.
nat-policy-name
Specifies the NAT policy to be used in NAT redirect.
policy-name
Specifies an IPv4 redirect policy configured in the config>filter>redirect-policy context.
sap-id
Specifies an existing VPLS Ethernet SAP.
sdp-id:vc-id
Specifies an existing VPLS SDP.
packet-length-value
Specifies integer value to be compared against “Total Length” field in the packet’s IPv4 header.
rdr-url-string
Specifies the HTTP web address that will be sent to the user’s browser.
router-instance
Specifies “Base” or an existing VPRN service ID.
service-name
Specifies an existing VPRN service name.
ttl-value
specifies an integer value to be compared against “Time-to-live” field in the packet’s IPv4 header.
vpls-service-id
Specifies an existing VPLS service ID or service name.
lt
Specifies “less than”. lt cannot be used with the lowest possible numerical value for the parameter.
eq
Specifies “equal to”. gt cannot be used with the highest possible numerical value for the parameter.
gt
Specifies “greater than”.
range
Specifies "an inclusive range". When range is used, the start of the range (first value entered) must be smaller than the end of the range (second value entered).
action(IPv6)
Syntax
drop
drop packet-length {{lt | eq | gt} packet-length-value | range packet-length-value packet-length-value}
forward
forward lsp lsp-name
forward next-hop [indirect] ipv6-address
forward next-hop [indirect] ipv6-address router {router-instance | service-name service-name}
forward redirect-policy policy-name
forward router {router-instance | service-name service-name}
forward sap sap-id
forward sdp sdp-id:vc-id
http-redirect rdr-url-string [allow-radius-override]
nat [nat-policy nat-policy-name] nat-type nat-type
Context
config>filter>ipv6-filter>entry
config>filter>ipv6-filter>entry>action
Description
The action command (under the config>filter>ipv6-filter context) sets the context for specific action commands to be performed (under the config>filter>ip-filter>action context) on packets matching this filter entry.
The following commands are available under the config>filter>ipv6-filter>entry>action context::
drop – A packet matching the entry will be dropped.
drop packet-length – A packet matching the entry will be dropped only if “Total Length” field in the packet’s IPv4 header meets the configured condition.
forward – A packet matching the entry will be forwarded using regular routing.
forward lsp – A packet matching the entry will be forwarded using the specified lsp.
forward next-hop – A packet matching the entry will be forwarded in the routing context of the incoming interface using direct or indirect IP address in the routing lookup.
forward next-hop router – A packet matching the entry will be forwarded in the configured routing context using direct or indirect IP address in the routing lookup.
forward redirect-policy – A packet matching the entry will be forwarded using forward next-hop or forward next-hop router and the IP address of destination selected by the configured redirect policy. If no destination is selected, packets are subject to action forward.
forward router – A packet matching the entry will be routed in the configured routing instance and not in the incoming interface routing instance.
forward sap – A packet matching the entry will be forwarded using the configured sap.
forward sdp – A packet matching the entry will be forwarded using the configured SDP.
gtp-local-breakout – A packet matching the entry will be forwarded to NAT instead of being GTP tunneled to mobile operator’s PGW or GGSN.
http-redirect – An HTTP GET packet matching an entry is forwarded to CPM for HTTP captive portal processing
nat – A packet matching the entry will be forwarded to NAT
reassemble – A packets matching the entry will be forwarded to the reassembly function.
Default
no specific action is configured by default.
Parameters
ipv6-address
Specifies the IPv6 address of a direct or indirect next-hop to which to forward matching packets.
ip-int-name
Specifies the name of an egress IP interface where matching packets will be forwarded from. This parameter is only valid for unnumbered point-to-point interfaces. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
lsp-name
Specifies an existing RSVP-TE or MPLS-TP LSP that supports LSP redirect.
nat-policy-name
Specifies the NAT policy to be used in NAT redirect.
nat-type
Specifies the nat-type to be either dslite or nat64.
policy-name
Specifies an IPv6 redirect policy configured in the config>filter>redirect-policy context.
sap-id
Specifies an existing VPLS Ethernet SAP.
sdp-id:vc-id
Specifies an existing VPLS SDP.
packet-length-value
Specifies integer value to be compared against “Total Length” field in the packet’s IPv4 header.
rdr-url-string
Specifies the HTTP web address that will be sent to the user’s browser.
router-instance
Specifies “Base” or an existing VPRN service ID.
service-name
Specifies an existing VPRN service name.
lt
Specifies “less than”. lt cannot be used with the lowest possible numerical value for the parameter.
eq
Specifies “equal to”. gt cannot be used with the highest possible numerical value for the parameter.
gt
Specifies “greater than”.
range
Specifies "an inclusive range". When range is used, the start of the range (first value entered) must be smaller than the end of the range (second value entered).
egress-pbr
egress-pbr {default-load-balancing | l4-load-balancing}
no egress-pbr
Context
config>filter>ip-filter>entry
Description
This command specifies that the configured PBR action is applicable to egress processing. The command should only be enabled in ACL policies used by residential subscribers. Enabling
egress-pbr on filters not deployed for residential subscribers is not blocked but can lead to unexpected behavior and thus should be avoided.
The no form of this command removes the egress-pbr designation of the filter entry's action.
Default
no egress-pbr
Parameters
load-balancing
Set load-balancing to default (hash based on SA/DA of the packet).
l4-load-balancing
SInclude TCP/UDP port (if available) in hash.
filter-sample
Syntax
[no] filter-sample
Context
config>filter>ip-filter>entry
config>filter>ipv6-filter>entry
Description
This command enabled cflowd sampling for packets matching this filter entry.
If the cflowd is either not enabled or set to cflowd interface mode, this command is ignored.
The no form disables the cflowd sampling using this filter entry.
Default
no filter-sample
interface-disable-sample
Syntax
[no] interface-disable-sample
Context
config>filter>ip-filter>entry
config>filter>ipv6-filter>entry
Description
This command disables cflowd sampling for packets matching this filter entry for the IP interface is set to cflowd interface mode. This allows the option to not sample specific types of traffic when interface sampling is enabled.
If the cflowd is either not enabled or set to cflowd acl mode, this command is ignored.
The no form of this command enables sampling.
Default
no interface-disable-sample
match
Syntax
match [protocol protocol-id]
no match
Context
config>filter>ip-filter>entry
config>filter>ipv6-filter>entry
Description
This command enables the context to enter match criteria for the filter entry. When the match criteria have been satisfied the action associated with the match criteria is executed.
A match context may consist of multiple match criteria, but multiple match statements cannot be entered per entry.
The no form of the command removes the match criteria for the entry-id.
Parameters
protocol
The protocol keyword configures an IP protocol to be used as an IP filter match criterion. The protocol type such as TCP or UDP is identified by its respective protocol number.
protocol-id
Configures the decimal value representing the IP protocol to be used as an IP filter match criterion. Well known protocol numbers include ICMP(1), TCP(6), UDP(17). The no form the command removes the protocol from the match criteria.
Values
0 — 255 (values can be expressed in decimal, hexidecimal, or binary - DHB)
keywords: none, crtp, crudp, egp, eigrp, encap, ether-ip, gre, icmp, idrp, igmp, igp, ip, ipv6, ipv6-frag, ipv6-icmp, ipv6-no-nxt, ipv6-opts, ipv6-route, isis, iso-ip, l2tp, ospf-igp, pim, pnni, ptp, rdp, rsvp, stp, tcp, udp, vrrp
* — udp/tcp wildcard
 
match
Syntax
match [next-header next-header]
no match
Context
config>filter>ipv6-filter>entry
Description
This command enables the context to enter match criteria for the filter entry. When the match criteria have been satisfied the action associated with the match criteria is executed.
IA match context may consist of multiple match criteria, but multiple match statements cannot be entered per entry.
The no form of the command removes the match criteria for the entry-id.
Parameters
next-header
Specifies the IPv6 next header to match. Note that this parameter is analogous to the protocol parameter used in IP-Filter match criteria.
Values
[0 — 42 | 45 — 49 | 52 — 59 | 61— 255] — protocol numbers accepted in decimal, hexidecimal, or binary - DHB
keywords: none, crtp, crudp, egp, eigrp, encap, ether-ip, gre, icmp, idrp, igmp, igp, ip, ipv6, ipv6-icmp, ipv6-no-nxt, isis, iso-ip, l2tp, ospf-igp, pim, pnni, ptp, rdp, rsvp, stp, tcp, udp, vrrp
* — udp/tcp wildcard
dscp
Syntax
dscp dscp-name
no dscp
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures a DiffServ Code Point (DSCP) name to be used as an IP filter match criterion.
The no form of the command removes the DSCP match criterion.
Default
no dscp
Parameters
dscp-name
Configure a dscp name that has been previously mapped to a value using the dscp-name command. The DiffServ code point may only be specified by its name.
Values
dst-ip
Syntax
dst-ip {ip-address/mask | ip-address ipv4-address-mask | ip-prefix-list prefix-list-name]}
dst-ip {ipv6-address/prefix-length | ipv6-address ipv6-address-mask }
no dst-ip
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures a destination address range to be used as a filter policy match criterion.
To match on the IPv4 or IPv6 destination address, specify the address and its associated mask, e.g., 10.1.0.0/16. The conventional notation of 10.1.0.0 255.255.0.0 can also be used for IPv4.
The no form of this command removes the destination IPv4 or IPv6 address match criterion.
Default
no destination IP match criteria
Parameters
ip-address
Specifies the destination IPv4 address specified in dotted decimal notation.
Values
mask
Specify the length in bits of the subnet mask.
Values
ipv4-address-mask
Specify the subnet mask in dotted decimal notation.
Values
ip-prefix-list
Creates a list of IPv4 prefixes for match criteria in QoS policies. An ip-prefix-list must contain only IPv4 address prefixes.
prefix-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
ipv6-address
The IPv6 prefix for the IP match criterion in hex digits.
Values
prefix-length
The IPv6 prefix length for the ipv6-address expressed as a decimal integer.
Values
mask
Eight 16-bit hexadecimal pieces representing bit match criteria.
Values
dst-port
Syntax
dst-port {lt | gt | eq} dst-port-number
dst-port port-list-name
dst-port range dst-port-number dst-port-number
no dst-port
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures a destination TCP, UDP, or SCTP port number or port range for an IP filter match criterion. Note that an entry containing Layer 4 non-zero match criteria will not match non-initial (2nd, 3rd, etc) fragments of a fragmented packet since only the first fragment contains the Layer 4 information.
The no form of the command removes the destination port match criterion.
Default
none
Parameters
lt | gt | eq
Specifies the operator to use relative to dst-port-number for specifying the port number match criteria.
lt specifies all port numbers less than dst-port-number match.
gt specifies all port numbers greater than dst-port-number match.
eq specifies that dst-port-number must be an exact match.
eq
Specifies the operator to use relative to dst-port-number for specifying the port number match criteria. The eq keyword specifies that dst-port-number must be an exact match.
dst-port-number
The destination port number to be used as a match criteria expressed as a decimal integer.
Values
port-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
range dst-port-number dst-port-number
Specifies inclusive port range between two dst-port-number values.
flow-label
Syntax
flow-label flow-label [mask]
no flow-label
Context
config>filter>ipv6-filter>entry>match
Description
This command configures the flow-label and optional mask match condition.
The no form of the command reverts to the default.
Default
no flow-label
Parameters
flow-label
Specifies the flow label to be used as a match criterion.
Values
mask
Specifies the flow label mask value for this policy IP Filter entry.
Values
fragment
Syntax
IPv4:
fragment {true|false}
no fragment
IPv6:
fragment {true|false|first-only|non-first-only}
no fragment
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command specifies match criterion for fragmented packets.
The no form of the command removes the match criterion.
Default
no fragment
Parameters
true
Specifies to match on all fragmented IP packets.
false
Specifies to match on all non-fragmented IP packets.
first-only
For IPv6: Matches if a packet is an initial fragment of a fragmented IPv6 packet.
non-first-only
For IPv6: Matches if a packet is a non-initial fragment of a fragmented IPv6 packet.
ah-ext-hdr
ah-ext-hdr {true|false }
no ah-ext-hdr
Context
config>filter>ipv6-filter>entry>match
Description
This command enables match on existence of AH Extension Header in the IPv6 filter policy.
The no form of this command ignores AH Extension Header presence/absence in a packet when evaluating match criteria of a given filter policy entry.
Default
no ah-ext-hdr
Parameters
true
Matches a packet with an AH Extension Header.
false
Match a packet without an AH Extension Header.
esp-ext-hdr
Syntax
esp-ext-hdr {true|false }
no esp-ext-hdr
Context
config>filter>ipv6-filter>entry>match
Description
This command enables match on existence of ESP Extension Header in the IPv6 filter policy.
The no form of this command ignores ESP Extension Header presence/absence in a packet when evaluating match criteria of a given filter policy entry.
Default
no esp-ext-hdr
Parameters
true
Matches a packet with an ESP Extension Header.
false
Match a packet without an ESP Extension Header.
hop-by-hop-opt
Syntax
hop-by-hop-opt {true|false}
no hop-by-hop-opt
Context
config>filter>ipv6-filter>entry>match
Description
This command enables match on existence of Hop-by-Hop Options Extension Header in the IPv6 filter policy.
The no form of this command ignores Hop-by-Hop Options Extension Header presence/absence in a packet when evaluating match criteria of a given filter policy entry.
Default
hop-by-hop-opt
Parameters
true
Matches a packet with a Hop-by-hop Options Extensions header.
false
Matches a packet without a Hop-by-hop Options Extensions header.
icmp-code
Syntax
icmp-code icmp-code
no icmp-code
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
Configures matching on ICMP/ICMPv6 code field in the ICMP/ICMPv6 header of an IP or IPv6 packet as a filter match criterion. Note that an entry containing Layer 4 non-zero match criteria will not match non-initial (2nd, 3rd, etc) fragments of a fragmented packet since only the first fragment contains the Layer 4 information.
The no form of the command removes the criterion from the match entry.
Default
no icmp-code
Parameters
icmp-code
The ICMP/ICMPv6 code values that must be present to match.
Values
icmp-type
Syntax
icmp-type icmp-type
no icmp-type
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures matching on the ICMP/ICMPv6 type field in the ICMP/ICMPv6 header of an IP or IPv6 packet as a filter match criterion. Note that an entry containing Layer 4 non-zero match criteria will not match non-initial (2nd, 3rd, etc) fragments of a fragmented packet since only the first fragment contains the Layer 4 information.
The no form of the command removes the criterion from the match entry.
Default
no icmp-type
Parameters
icmp-type
The ICMP/ICMPv6 type values that must be present to match.
Values
ip-option
Syntax
ip-option ip-option-value [ip-option-mask]
no ip-option
Context
config>filter>ip-filter>entry>match
Description
This command configures matching packets with a specific IP option or a range of IP options in the first option of the IP header as an IP filter match criterion.
The option-type octet contains 3 fields:
1 bit copied flag (copy options in all fragments)
2 bits option class
5 bits option number
The no form of the command removes the match criterion.
Default
none
Parameters
ip-option-value
Enter the 8 bit option-type as a decimal integer. The mask is applied as an AND to the option byte, the result is compared with the option-value.
The decimal value entered for the match should be a combined value of the eight bit option type field and not just the option number. Thus to match on IP packets that contain the Router Alert option (option number = 20), enter the option type of 148 (10010100).
Values
ip-option-mask
This is optional and may be used when specifying a range of option numbers to use as the match criteria.
This 8 bit mask can be configured using the following formats:
Default
Values
multiple-option
Syntax
multiple-option {true | false}
no multiple-option
Context
config>filter>ip-filter>entry>match
Description
This command configures matching packets that contain one or more than one option fields in the IP header as an IP filter match criterion.
The no form of the command removes the checking of the number of option fields in the IP header as a match criterion.
Default
no multiple-option
Parameters
­true
Specifies matching on IP packets that contain more than one option field in the header.
false
Specifies matching on IP packets that do not contain multiple option fields present in the header.
option-present
Syntax
option-present {true | false}
no option-present
Context
config>filter>ip-filter>entry>match
Description
This command configures matching packets that contain the option field in the IP header as an IP filter match criterion.
The no form of the command removes the checking of the option field in the IP header as a match criterion.
Parameters
true
Specifies matching on all IP packets that contain the option field in the header. A match will occur for all packets that have the option field present. An option field of zero is considered as no option present.
false
Specifies matching on IP packets that do not have any option field present in the IP header. (an option field of zero). An option field of zero is considered as no option present.
port
Syntax
port {lt|gt|eq} port-number
port port-list port-list-name
port range port-number port-number
no port
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures port match conditions.
Parameters
lt|gt|eq
Specifies the lower, greater or equal value for the TCP/UDP/SCTP port range.
port-number
Specifies the name given to this port list.
Values
range port-number port-number
Specifies inclusive port range between two port-number values.
routing-type0
Syntax
routing-type0 {true|false}
no routing-type0
Context
config>filter>ipv6-filter>entry>match
Description
This command enables match on existence of Routing Type Extension Header type 0 in the IPv6 filter policy.
The no form of this command ignores Routing Type Extension Header type 0 presence/absence in a packet when evaluating match criteria of a given filter policy entry.
Default
no routing-type0
Parameters
true
match if a packet contains Routing Type Extension Header type 0
false
match if a packet does not contain Routing Type Extension Header type 0
src-ip
Syntax
src-ip {ip-address/mask | ip-address ipv4-address-mask | ip-prefix-list prefix-list-name}
src-ip {ipv6-address/prefix-length | ipv6-address ipv6-address-mask | ipv6-prefix-list prefix-list-name}
no src-ip
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures a source IPv4 or IPv6 address range to be used as an IP filter match criterion.
To match on the source IPv4 or IPv6 address, specify the address and its associated mask, e.g. 10.1.0.0/16 for IPv4. The conventional notation of 10.1.0.0 255.255.0.0 may also be used for IPv4.
The no form of the command removes the source IP address match criterion.
Default
no src-ip
Parameters
ip-address
Specifies the destination IPv4 address specified in dotted decimal notation.
Values
mask
Specify the length in bits of the subnet mask.
Values
ipv4-address-mask
Specify the subnet mask in dotted decimal notation.
Values
ip-prefix-list
Creates a list of IPv4 prefixes for match criteria in QoS policies. An ip-prefix-list must contain only IPv4 address prefixes.
prefix-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
ipv6-address
The IPv6 prefix for the IP match criterion in hex digits.
Values
prefix-length
The IPv6 prefix length for the ipv6-address expressed as a decimal integer.
Values
mask
Eight 16-bit hexadecimal pieces representing bit match criteria.
Values
src-port
Syntax
src-port {lt | gt | eq} src-port-number
src-port port-list port-list-name
src-port range src-port-number src-port-number
no src-port
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures a source TCP, UDP, or SCTP port number, port range, or port match list for an IP filter match criterion. Note that an entry containing Layer 4 non-zero match criteria will not match non-initial (2nd, 3rd, etc) fragments of a fragmented packet since only the first fragment contains the Layer 4 information.
The no form of the command removes the source port match criterion.
Default
no src-port
Parameters
lt | gt | eq
Specifies the operator to use relative to src-port-number for specifying the port number match criteria.
lt specifies all port numbers less than src-port-number match.
gt specifies all port numbers greater than src-port-number match.
eq specifies that src-port-number must be an exact match.
src-port-number
The source port number to be used as a match criteria expressed as a decimal integer.
Values
port-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes. <<R12.0>>
range src-port-number src-port-number
Specifies inclusive port range between two src-port-number values.
src-route-option
Syntax
src-route-option {true|false}
no source-route-option
Context
config>filter>ip-filter>entry>match
Description
This command enables source route option match conditions. When enabled, this filter should match if a (strict or loose) source route option is present/not present at any location within the IP header, as per the value of this object.
Parameters
true
Enables source route option match conditions.
false
Disables source route option match conditions.
tcp-ack
Syntax
tcp-ack {true | false}
no tcp-ack
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures matching on the ACK bit being set or reset in the control bits of the TCP header of an IP packet as an IP filter match criterion. Note that an entry containing Layer 4 non-zero match criteria will not match non-initial (2nd, 3rd, etc) fragments of a fragmented packet since only the first fragment contains the Layer 4 information.
The no form of the command removes the criterion from the match entry.
Default
no tcp-ack
Parameters
true
Specifies matching on IP packets that have the ACK bit set in the control bits of the TCP header of an IP packet.
false
Specifies matching on IP packets that do not have the ACK bit set in the control bits of the TCP header of the IP packet.
tcp-syn
Syntax
tcp-syn {true | false}
no tcp-syn
Context
config>filter>ip-filter>entry>match
config>filter>ipv6-filter>entry>match
Description
This command configures matching on the SYN bit being set or reset in the control bits of the TCP header of an IP packet as an IP filter match criterion. Note that an entry containing Layer 4 non-zero match criteria will not match non-initial (2nd, 3rd, etc) fragments of a fragmented packet since only the first fragment contains the Layer 4 information.
The SYN bit is normally set when the source of the packet wants to initiate a TCP session with the specified destination IP address.
The no form of the command removes the criterion from the match entry.
Default
no tcp-syn
Parameters
true
Specifies matching on IP packets that have the SYN bit set in the control bits of the TCP header.
false
Specifies matching on IP packets that do not have the SYN bit set in the control bits of the TCP header.
 
Match List Configuration Commands
match-list
Syntax
match-list
Context
config>filter
Description
This command enables the configuration context for match lists to be used in filter policies (IOM and CPM).
ip-prefix-list
Syntax
ip-prefix-list ip-prefix-list-name create
no ip-prefix-list ip-prefix-list-name
Context
config>filter>match-list
Description
This command creates a list of IPv4 prefixes for match criteria in IPv4 ACL and CPM filter policies.
The no form of this command deletes the specified list.
Operational notes:
An ip-prefix-list must contain only IPv4 address prefixes.
An IPv4 prefix match list cannot be deleted if it is referenced by a filter policy.
Please see general description related to match-list usage in filter policies.
Default
none
Parameters
ip-prefix-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
ipv6-prefix-list
Syntax
ipv6-prefix-list ipv6-prefix-list-name create
no ipv6-prefix-list ipv6-prefix-list-name
Context
config>filter>match-list
Description
This command creates a list of IPv6 prefixes for match criteria in ACL and CPM IPv6 filter policies.
The no form of this command deletes the specified list.
Operational notes:
An ipv6-prefix-list must contain only IPv6 address prefixes.
An IPv6 prefix match list cannot be deleted if it is referenced by a filter policy.
Please see general description related to match-list usage in filter policies.
Parameters
ipv6-prefix-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
apply-path
Syntax
apply-path
no apply-path
Context
config>filter>match-list>ip-pfx-list
config>filter>match-list>ipv6-pfx-list
Description
This command enables context to configure auto-generation of address prefixes for IPv4 or IPv6 address prefix match lists. The context the command is executed governs whether IPv4 or IPv6 prefixes will be auto-generated.
The no form of this command removes all auto-generation configuration under the apply-path context.
Default
no apply path
bgp-peers
Syntax
bgp-peers index group reg-exp neighbor reg-exp
no bgp-peers index
Context
config>filter>match-list>ip-pfx-list>apply-path
config>filter>match-list>ipv6-pfx-list>apply-path
Description
This command configures auto-generation of IPv4 or IPv6 address prefixes (as required by the context the command is executed within) based on the base router BGP instance configuration.
group:
Configures a match against base router BGP instance group configuration.
Regex wildcard match (.*) can be used to match against any group.
neighbor:
Configures a match against base router BGP instance neighbor configuration.
Regex wildcard match (.*) can be used to match against any neighbor.
The no form of this command removes the bgp-peers configuration for auto-generation of address prefixes for the specified index value.
Default
No embedded filter policies are included in a filter policy.
Parameters
index
An integer from 1 to 255 enumerating bgp-peers auto-generation configuration within this list.
reg-exp
A regular expression defining a macth string to be used to auto generate address prefixes. Matching is performed from the least significant digit. For example a string 10.0 matches all neighbors with addresses starting with 10; like 10.0.x.x or 10.0xx.x.x.
port-list
Syntax
port-list port-list-name create
no port-list port-list-name
Context
config>filter>match-list
Description
This command creates a list of TCP/UDP/SCTP port values or ranges for match criteria in IPv4 and IPv6 ACL and CPM filter policies.
The no form of this command deletes the specified list.
Operational notes:
SCTP port match is supported in ACL filter policies only.
A port-list must contain only TCP/UDP/SCTP port values or ranges.
A TCP/UDP/SCTP port match list cannot be deleted if it is referenced by a filter policy.
Please see general description related to match-list usage in filter policies.
Parameters
port-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
Default
no ports are added to a port list by default.
port
Syntax
port port-number
port range start end
no port
Context
config>filter>match-list>port-list
Description
This command configures a TCP/UDP/SCTP source or destination port match criterion in IPv4 and IPv6 CPM (SCTP not supported) and/or ACL filter policies. A packet matches this criterion if the packet TCP/UDP/SCTP (as configured by protocol/next-header match) source OR destination port matches either the specified port value or a port in the specified port range or port-list.
This command is mutually exclusive with src-port and dst-port commands.
The no form of this command deletes the specified port match criterion.
Default
no port
Parameters
port-number
A source or destination port to be used as a match criterion specified as a decimal integer.
Values
range start end
an inclusive range of source or destination port values to be used as match criteria. start of the range and end of the range are expressed as decimal integers.
Values
port-list-name
A string of up to 32 characters of printable ASCII characters. If special characters are used, the string must be enclosed within double quotes.
prefix
Syntax
prefix ipv6-prefix/prefix-length
no prefix ipv6-prefix/prefix-length
Context
config>filter>match-list>ipv6-pfx-list
Description
This command adds an IPv6 address prefix to an existing IPv6 address prefix match list.
The no form of this command deletes the specified prefix from the list.
Operational notes:
To add set of different prefixes, execute the command with all unique prefixes. The prefixes are allowed to overlap IPv6 address space.
An IPv6 prefix addition will be blocked, if resource exhaustion is detected anywhere in the system because of Filter Policies that use this IPv6 address prefix list.
Default
No prefixes are in the list by default
Parameters
ipv6-prefix
A An IPv6 address prefix written as hexadecimal numbers separated by colons with host bits set to 0. One string of zeros can be omitted so 1010::700:0:217A is equivalent to 1010:0:0:0:0:700:0:217A
Values
prefix-length
Length of the entered IP prefix.
Values
prefix
Syntax
prefix ip-prefix/prefix-length
no prefix ip-prefix/prefix-length
Context
config>filter>match-list>ip-prefix-list
Description
This command adds an IPv4 address prefix to an existing IPv4 address prefix match list.
The no form of this command deletes the specified prefix from the list.
Operational notes:
To add set of unique prefixes, execute the command with all unique prefixes. The prefixes are allowed to overlap IPv4 address space.
An IPv4 prefix addition will be blocked, if resource exhaustion is detected anywhere in the system because of Filter Policies that use this IPv4 address prefix list.
Default
none
Parameters
ip-prefix
A valid IPv4 address prefix in dotted decimal notation.
Values
prefix-length
Length of the entered IP prefix.
Values
 
MAC Filter Entry Commands
action
Syntax
drop
forward
forward esi esi service-id vpls-service-id
forward sap sap-id
forward sdp sdp-id:vc-id
http-redirect url
Context
config>filter>mac-filter>entry
config>filter>mac-filter>entry>action
Description
The action command (under the config>filter>mac-filter context) sets the context for specific action commands to be performed (under the config>filter>mac-filter>action context) on packets matching this filter entry.
The following commands are available under the config>filter>mac-filter>entry>action context::
drop – A packet matching the entry will be dropped.
forward – A packet matching the entry will be forwarded using regular routing.
forward esi service-id– A packet matching the entry will be forwarded to an ESI identified first appliance in Nuage service chain using EVPN-resolved VXLAN tunnel in the specified VPLS service.
forward sap – A packet matching the entry will be forwarded using the configured sap.
forward sdp – A packet matching the entry will be forwarded using the configured SDP.
http-redirect – Unsupported
Default
no specific action is configured by default
Parameters
esi
Specifies a 10-Byte Ethernet Segment Identifier.
sap-id
Specifies an existing VPLS Ethernet SAP.
sdp-id:vc-id
Specifies an existing red VPLS SDP.
url
Specifies the HTTP web address that will be sent to the user’s browser.
vpls-service-id
Specifies an existing VPLS service ID or service name.
match
Syntax
match [frame-type 802dot3 | 802dot2-llc | 802dot2-snap | ethernet_II]
no match
Context
config>filter>mac-filter>entry
Description
This command creates the context for entering/editing match criteria for the filter entry and specifies an Ethernet frame type for the entry.
A match context may consist of multiple match criteria, but multiple match statements cannot be entered per entry.
The no form of the command removes the match criteria for the entry-id.
Parameters
frame-type keyword
The frame-type keyword configures an Ethernet frame type to be used for the MAC filter match criteria.
Default
Values
802dot3
Specifies the frame type is Ethernet IEEE 802.3.
802dot2-llc
Specifies the frame type is Ethernet IEEE 802.2 LLC.
802dot2-snap
Specifies the frame type is Ethernet IEEE 802.2 SNAP.
ethernet_II
Specifies the frame type is Ethernet Type II.
 
MAC Filter Match Criteria
dot1p
Syntax
dot1p ip-value [mask]
no dot1p
Context
config>filter>mac-filter>entry
Description
Configures an IEEE 802.1p value or range to be used as a MAC filter match criterion.
When a frame is missing the 802.1p bits, specifying an dot1p match criterion will fail for the frame and result in a non-match for the MAC filter entry.
The no form of the command removes the criterion from the match entry.
SAP Egress
Egress dot1p value matching will only match if the customer payload contains the 802.1p bits. For example, if a packet ingresses on a null encapsulated SAP and the customer packet is IEEE 802.1Q or 802.1p tagged, the 802.1p bits will be present for a match evaluation. On the other hand, if a customer tagged frame is received on a dot1p encapsulated SAP, the tag will be stripped on ingress and there will be no 802.1p bits for a MAC filter match evaluation; in this case, any filter entry with a dot1p match criterion specified will fail.
Default
no dot1p
Parameters
ip-value
The IEEE 802.1p value in decimal.
Values
mask
This 3-bit mask can be configured using the following formats:
To select a range from 4 up to 7 specify p-value of 4 and a mask of 0b100 for value and mask.
Default
Values
dsap
Syntax
dsap dsap-value [mask]
no dsap
Context
config>filter>mac-filter>entry>match
Description
Configures an Ethernet 802.2 LLC DSAP value or range for a MAC filter match criterion.
This is a one-byte field that is part of the 802.2 LLC header of the IEEE 802.3 Ethernet Frame.
The snap-pid field, etype field, ssap and dsap fields are mutually exclusive and may not be part of the same match criteria.
Use the no form of the command to remove the dsap value as the match criterion.
Default
no dsap
Parameters
dsap-value
The 8-bit dsap match criteria value in hexadecimal.
Values
mask
This is optional and may be used when specifying a range of dsap values to use as the match criteria.
This 8 bit mask can be configured using the following formats:
Default
0x00 — 0xFF
dst-mac
Syntax
dst-mac ieee-address [mask]
no dst-mac
Context
config>filter>mac-filter>entry
Description
Configures a destination MAC address or range to be used as a MAC filter match criterion.
The no form of the command removes the destination mac address as the match criterion.
Default
no dst-mac
Parameters
ieee-address
The MAC address to be used as a match criterion.
Values
mask
A 48-bit mask to match a range of MAC address values.
This 48-bit mask can be configured using the following formats:
 
To configure so that all packets with a source MAC OUI value of 00-03-FA are subject to a match condition then the entry should be specified as: 0003FA000000 0x0FFFFF000000
Default
Values
etype
Syntax
etype ethernet-type
no etype
Context
config>filter>mac-filter>entry
Description
Configures an Ethernet type II Ethertype value to be used as a MAC filter match criterion.
The Ethernet type field is a two-byte field used to identify the protocol carried by the Ethernet frame. For example, 0800 is used to identify the IPv4 packets.
The Ethernet type field is used by the Ethernet version-II frames. IEEE 802.3 Ethernet frames do not use the type field. For IEEE 802.3 frames, use the dsap, ssap or snap-pid fields as match criteria.
The snap-pid field, etype field, ssap and dsap fields are mutually exclusive and may not be part of the same match criteria.
The no form of the command removes the previously entered etype field as the match criteria.
Default
no etype
Parameters
ethernet-type
The Ethernet type II frame Ethertype value to be used as a match criterion expressed in hexadecimal.
Values
isid
Syntax
isid value [to higher-value]
no isid
Context
config>filter>mac-filter>entry>match
Description
This command configures an ISID value or a range of ISID values to be matched by the mac-filter parent. The pbb-etype value for the related SAP (inherited from the ethernet port configuration) or for the related SDP binding (inherited from SDP configuration) will be used to identify the ISID tag.
The no form of this command removes the ISID match criterion.
Default
no isid
value
Specifies the ISID value, 24 bits. When just one present identifies a particular ISID to be used for matching.
to higher-value
Identifies a range of ISIDs to be used as matching criteria.
inner-tag
Syntax
inner-tag value [vid-mask]
no inner-tag
Context
config>filter>mac-filter>entry>match
Description
This command configures the matching of the second tag that is carried transparently through the service. The inner-tag on ingress is the second tag on the frame if there are no service delimiting tags. Inner tag is the second tag before any service delimiting tags on egress but is dependent in the ingress configuration and may be set to 0 even in cases where additional tags are on the frame. This allows matching VLAN tags for explicit filtering or QoS setting when using default or null encapsulations.
The inner-tag is not applicable in ingress on dot1Q SAPs. The inner-tag may be populated on egress depending on the ingress SAP type.
On QinQ SAPs of null and default that do not strip tags inner-tag will contain the second tag (which is still the second tag carried transparently through the service.) On ingress SAPs that strip any tags, inner-tag will contain 0 even if there are more than 2 tags on the frame.
The optional vid_mask is defaulted to 4095 (exact match) but may be specified to allow pattern matching. The masking operation is ((value and vid-mask) = = (tag and vid-mask)). A value of 6 and a mask of 7 would match all VIDs with the lower 3 bits set to 6.
Note for QoS the VID type cannot be specified on the default QoS policy.
The default vid-mask is set to 4095 for exact match.
outer-tag
Syntax
outer-tag value [vid-mask]
no outer-tag
Context
config>filter>mac-filter>entry>match
Description
This command configures the matching of the first tag that is carried transparently through the service. Service delimiting tags are stripped from the frame and outer tag on ingress is the first tag after any service delimiting tags. Outer tag is the first tag before any service delimiting tags on egress. This allows matching VLAN tags for explicit filtering or QoS setting when using default or null encapsulations.
On dot1Q SAPs outer-tag is the only tag that can be matched. On dot1Q SAPs with exact match (sap 2/1/1:50) the outer-tag will be populated with the next tag that is carried transparently through the service or 0 if there is no additional VLAN tags on the frame.
On QinQ SAPs that strip a single service delimiting tag, outer-tag will contain the next tag (which is still the first tag carried transparently through the service.) On SAPs with two service delimiting tags (two tags stripped) outer-tag will contain 0 even if there are more than 2 tags on the frame.
The optional vid_mask is defaulted to 4095 (exact match) but may be specified to allow pattern matching. The masking operation is ((value & vid-mask) = = (tag & vid-mask)). A value of 6 and a mask of 7 would match all VIDs with the lower 3 bits set to 6.
Note for QoS the VID type cannot be specified on the default QoS policy.
The default vid-mask is set to 4095 for exact match.
snap-oui
Syntax
snap-oui [zero | non-zero]
no snap-oui
Context
config>filter>mac-filter>entry
Description
This command configures an IEEE 802.3 LLC SNAP Ethernet Frame OUI zero or non-zero value to be used as a MAC filter match criterion.
The no form of the command removes the criterion from the match criteria.
Default
no snap-oui
Parameters
zero
Specifies to match packets with the three-byte OUI field in the SNAP-ID set to zero.
non-zero
Specifies to match packets with the three-byte OUI field in the SNAP-ID not set to zero.
snap-pid
Syntax
snap-pid pid-value
no snap-pid
Context
config>filter>mac-filter>entry
Description
Configures an IEEE 802.3 LLC SNAP Ethernet Frame PID value to be used as a MAC filter match criterion.
This is a two-byte protocol id that is part of the IEEE 802.3 LLC SNAP Ethernet Frame that follows the three-byte OUI field.
The snap-pid field, etype field, ssap and dsap fields are mutually exclusive and may not be part of the same match criteria.
Note: The snap-pid match criterion is independent of the OUI field within the SNAP header. Two packets with different three-byte OUI fields but the same PID field will both match the same filter entry based on a snap-pid match criteria.
The no form of the command removes the snap-pid value as the match criteria.
Default
no snap-pid
Parameters
pid-value
The two-byte snap-pid value to be used as a match criterion in hexadecimal.
Values
src-mac
Syntax
src-mac ieee-address [ieee-address-mask]
no src-mac
Context
config>filter>mac-filter>entry
Description
Configures a source MAC address or range to be used as a MAC filter match criterion.
The no form of the command removes the source mac as the match criteria.
Default
no src-mac
Parameters
ieee-address
Enter the 48-bit IEEE mac address to be used as a match criterion.
Values
ieee-address-mask
This 48-bit mask can be configured using:
To configure so that all packets with a source MAC OUI value of 00-03-FA are subject to a match condition then the entry should be specified as: 003FA000000 0xFFFFFF000000
Default
0xFFFFFFFFFFFF (exact match)
Values
ssap
Syntax
ssap ssap-value [ssap-mask]
no ssap
Context
config>filter>mac-filter>entry
Description
This command configures an Ethernet 802.2 LLC SSAP value or range for a MAC filter match criterion.
This is a one-byte field that is part of the 802.2 LLC header of the IEEE 802.3 Ethernet Frame.
The snap-pid field, etype field, ssap and dsap fields are mutually exclusive and may not be part of the same match criteria.
The no form of the command removes the ssap match criterion.
Default
no ssap
Parameters
ssap-value
The 8-bit ssap match criteria value in hex.
Values
ssap-mask
This is optional and may be used when specifying a range of ssap values to use as the match criteria.
This 8 bit mask can be configured using the following formats:
Default
Values
 
Policy and Entry Maintenance Commands
copy
Syntax
copy ip-filter src-filter-id [src-entry src-entry-id] to dst-filter-id [dst-entry dst-entry-id] [overwrite]
copy ipv6-filter src-filter-id [src-entry src-entry-id] to dst-filter-id [dst-entry dst-entry-id] [overwrite]
copy mac-filter src-filter-id [src-entry src-entry-id] to dst-filter-id [dst-entry dst-entry-id] [overwrite]
Context
config>filter
Description
This command copies existing filter list entries for a specific filter ID to another filter ID. The copy command is a configuration level maintenance tool used to create new filters using existing filters. It also allows bulk modifications to an existing policy with the use of the overwrite keyword.
If overwrite is not specified, an error will occur if the destination policy ID exists.
Parameters
ip-filter
Indicates that the source-filter-id and the dest-filter-id are IP filter IDs.
ipv6-filter
This keyword indicates that the source-filter-id and the dest-filter-id are IPv6 filter IDs.
mac-filter
Indicates that the source-filter-id and the dest-filter-id are MAC filter IDs.
source-filter-id
The source-filter-id identifies the source filter policy from which the copy command will attempt to copy. The filter policy must exist within the context of the preceding keyword (ip-filter, ipv6-filter or mac-filter).
dest-filter-id
The dest-filter-id identifies the destination filter policy to which the copy command will attempt to copy. If the overwrite keyword does not follow, the filter policy ID cannot already exist within the system for the filter type the copy command is issued for. If the overwrite keyword is present, the destination policy ID may or may not exist.
overwrite
The overwrite keyword specifies that the destination filter ID may exist. If it does, everything in the existing destination filter ID will be completely overwritten with the contents of the source filter ID. If the destination filter ID exists, either overwrite must be specified or an error message will be returned. If overwrite is specified, the function of copying from source to destination occurs in a ‘break before make’ manner and therefore should be handled with care.
renum
Syntax
renum old-entry-id new-entry-id
Context
config>filter>ip-filter
config>filter>ipv6-filter
config>filter>mac-filter
Description
This command renumbers existing MAC or IP filter entries to properly sequence filter entries.
This may be required in some cases since the OS exits when the first match is found and executes the actions according to the accompanying action command. This requires that entries be sequenced correctly from most to least explicit.
Parameters
old-entry-id
Enter the entry number of an existing entry.
Values
new-entry-id
Enter the new entry-number to be assigned to the old entry.
Values
 
Redirect Policy Commands
destination
Syntax
destination ip-address [create]
[no] destination ip-address
destination ipv6-address [create]
[no] destination ipv6-address
Context
config>filter>redirect-policy
Description
This command defines a destination in a redirect policy. More than one destination can be configured. Whether a destination IPv4/IPv6 address will receive redirected packets depends on the effective priority value after evaluation.
The most preferred destination is programmed in hardware as action forward next-hop. If all destinations are down (as determined by the supported tests), action forward is programmed in hardware. All destinations within a given policy must be either IPv4 or (exclusive) IPv6. The redirect policy with IPv4 destinations configured can only be used by IP filter policies. The redirect policy with IPv6 destinations configured can only be used by IPv6 filter policies.
Default
no destination
Parameters
ip-address
Specifies the IPv4 address to send the redirected traffic.
Values
ipv6-address
Specifies the IPv6 address to send the redirected traffic.
Values
router
Syntax
router router-instance
router service name service-name
no router
Context
config>filter>redirect-policy
Description
This command enhances VRF support in redirect policies. The following applies when a router instance is specified:
the PBR action is executed in the specified router instance.
Note – If no destination is active or if the hardware does not support the PBR action next-hop router, action forward will be executed (i.e. routing will be performed in the context of the incoming interface routing instance).
The no form of the command preserves backward-compatibility. Any test is always run in the "Base" routing instance context. The PBR action is executed in the routing context of the ingress interface the filter using this redirect policy is deployed on.
Default
no router
Parameters
router-instance - <router-name> | <service-id
router-name
Base.
service-id
An existing L3 service.
Values
service-name
Name of the configured L3 service.
sticky-dest
Syntax
sticky-dest no-hold-time-up
sticky-dest hold-time-up seconds
no sticky-dest
Context
config>filter>redirect-policy
Description
This command configures sticky destination behavior for redirect policy. When enabled, the active destination is not changed to a new better destination, unless the active destination goes down or manual switch is forced using the tools>perform>filter>redirect-policy>activate-best-dest command.
An optional hold-time-up allows the operator to delay programming of the PBR to the most-preferred destination for a specified amount of time when the first destination comes up (action forward remains in place). When the first destination comes up, the timer is started and upon the expiry, the current most-preferred destination is selected (which may differ from the one that triggered the timer to start) and programmed as a sticky PBR destination. Changing the value of the timer, while the timer is running takes immediate effect.
The no form of the command disables sticky destination behavior.
Default
no sticky-dest
Parameters
seconds
Initial delay in seconds.
Values
ping-test
Syntax
[no] ping-test
Context
config>filter>destination>ping-test
config>filter>destination>snmp-test
Description
This command configures parameters to perform connectivity ping tests to validate the ability for the destination to receive redirected traffic.
Default
none
drop-count
Syntax
drop-count consecutive-failures [hold-down seconds]
no drop-count
Context
config>filter>destination>ping-test
config>filter>destination>snmp-test
config>filter>destination>url-test
Description
This command specifies the number of consecutive requests that must fail for the destination to be declared unreachable and the time hold-down time to held destination unreachable before repeating tests.
Default
drop-count 3 hold-down 0
Parameters
consecutive-failures
Specifies the number of consecutive ping test failures before declaring the destination down.
Values
hold-down seconds
The amount of time, in seconds, that the system should be held down if any of the test has marked it unreachable.
Values
interval
Syntax
interval seconds
no interval
Context
config>filter>destination>ping-test
config>filter>destination>snmp-test
config>filter>destination>url-test
Description
This command specifies the amount of time, in seconds, between consecutive requests sent to the far end host.
Default
1
Parameters
seconds
Specifies the amount of time, in seconds, between consecutive requests sent to the far end host.
Values
timeout
Syntax
timeout seconds
no timeout
Context
config>filter>destination>snmp-test
config>filter>destination>url-test
Description
Specifies the amount of time, in seconds, that is allowed for receiving a response from the far-end host. If a reply is not received within this time the far-end host is considered unresponsive.
Default
1
Parameters
seconds
Specifies the amount of time, in seconds, that is allowed for receiving a response from the far end host.
Values
priority
Syntax
priority priority
no priority
Context
config>filter>destination
Description
Redirect policies can contain multiple destinations. Each destination is assigned an initial or base priority which describes its relative importance within the policy.
Default
100
Parameters
priority
The priority, expressed as a decimal integer, used to weigh the destination’s relative importance within the policy.
Values
snmp-test
Syntax
snmp-test test-name
Context
config>filter>redirect-policy>destination
Description
This command enables the context to configure SNMP test parameters.
Default
none
Parameters
test-name
specifies the name of the SNMP test. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
oid
Syntax
oid oid-string community community-string
Context
config>filter>redirect-policy>destination>snmp-test
Description
This command specifies the OID of the object to be fetched from the destination.
Default
none
Parameters
oid-string
Specifies the object identifier (OID) in the OID field.
community community-string
The SNMP v2 community string or the SNMP v3 context name used to conduct this SNMP test.
return-value
Syntax
return-value return-value type return-type [disable | lower-priority priority | raise-priority priority]
Context
config>filter>redirect-policy>destination>snmp-test
Description
This command specifies the criterion to adjust the priority based on the test result. Multiple criteria can be specified with the condition that they are not conflicting or overlap. If the returned value is within the specified range, the priority can be disabled, lowered or raised.
Default
none
Parameters
return-value
Specifies the SNMP value against which the test result is matched.
Values
return-type
Specifies the SNMP object type against which the test result is matched.
Values
disable
The keyword that specifies that the destination may not be used for the amount of time specified in the hold-time command when the test result matches the criterion.
lower-priority priority
Specifies the amount to lower the priority of the destination.
Values
raise-priority priority
Specifies the amount to raise the priority of the destination.
Values
unicast-rt-test
Syntax
unicast-rt-test
no unicast-rt-test
Context
config>filter>redirect-policy>destination
Description
This command configures a unicast route test for this destination. A destination is eligible for redirect if a valid unicast route to that destination exists in the routing instance specified by config filter redirect-policy router. The unicast route test is mutually exclusive with other redirect-policy test types.
The test cannot be configured if no router is configured for this redirect policy.
The no form of the command disables the test.
Default
no unicast-rt-test
url-test
Syntax
url-test test-name
Context
config>filter>redirect-policy>destination
Description
The context to enable URL test parameters. IP filters can be used to selectively cache some web sites.
Default
none
Parameters
test-name
The name of the URL test. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
return-code
Syntax
return-code return-code-1 [return-code-2] [disable | lower-priority priority | raise-priority priority]
no return-code return-code-1 [return-code-2]
Context
config>filter>redirect-policy>destination>url-test
Description
Return codes are returned when the URL test is performed. Values for the specified range are the return codes which can be given back to the system as a result of the test been performed.
For example, error code 401 for HTTP is “page not found.” If, while performing this test, the URL is not reachable, you can lower the priority by 10 points so that other means of reaching this destination are prioritized higher than the older one.
Default
none
Parameters
return-code-1, return-code-2
Specifies a range of return codes. When the URL test return-code falls within the specified range, the corresponding action is performed.
Values
return-code-1: 1 — 4294967294
return-code-2: 2 — 4294967295
disable
Specifies that the destination may not be used for the amount of time specified in the hold-time command when the return code falls within the specified range.
lower-priority priority
Specifies the amount to lower the priority of the destination when the return code falls within the specified range.
raise-priority priority
Specifies the amount to raise the priority of the destination when the return code falls within the specified range.
url
Syntax
url url-string [http-version version-string]
Context
config>filter>redirect-policy>destination>url-test
Description
This command specifies the URL to be probed by the URL test.
Default
none
Parameters
url-string
Specify a URL up to 255 characters in length.
http-version version-string
Specifies the HTTP version, 80 characters in length.
router
Syntax
router router-instance
router service-name service-name
no router
Context
config>filter>redirect-policy
Description
This command enhances VRF support in redirect policies. When a router instance is specified, the configured destination tests are run in the specified router instance, and the PBR action is executed in the specified router instance. Note that if no destination is active or if the hardware does not support PBR action “next-hop router”, action forward will be executed (i.e. routing will be performed in the context of the incoming interface routing instance).
The no form of the command preserves backward-compatibility. Tests always run in the “Base” routing instance context, and the PBR action executes in the routing context of the ingress interface that the filter using this redirect policy is deployed on.
Default
no router
Parameters
router-instance
Specifies a router instance in the form of router-name or service-id.
Values
router-name — “Base”
service-id — an existing Layer 3 service [1..2147483647]
service-name
Specifies the name of a configured Layer 3 service.
shutdown
Syntax
[no] shutdown
Context
config>filter>redirect-policy
config>filter>redirect-policy>destination
Description
Administratively enables/disabled (AdminUp/AdminDown) an entity. Downing an entity does not change, reset or remove any configuration settings or statistics. Many objects must be shutdown before they may be deleted.
The shutdown command administratively downs an entity. Administratively downing an entity changes the operational state of the entity to down.
Unlike other commands and parameters where the default state will not be indicated in the configuration file, shutdown and no shutdown are always indicated in system generated configuration files.
The no form of the command puts an entity into the administratively enabled state.
Default
no shutdown