perform commands

The perform commands are YANG-modeled versions of the tools perform commands and are available in MD-CLI and NETCONF interfaces. The perform commands execute actions in the router, such as:
  • force a LAG subgroup to become active
  • set an IS-IS overload condition
  • terminate a Python script
perform 
card number 
power-cycle 
chassis reference chassis-number reference 
check-backplane-eprom 
filter 
ip-filter reference 
entry reference 
activate-primary-action 
ipv6-filter reference 
entry reference 
activate-primary-action 
redirect-policy reference 
activate-best-dest 
lag 
clear-force 
lag 
[lag-name] reference
sub-group number
multi-chassis 
all 
peer 
[ip-address] reference
force-active 
lag 
[lag-name] reference
sub-group number
multi-chassis 
all 
peer 
[ip-address] reference
force-standby 
lag 
[lag-name] reference
sub-group number
multi-chassis 
all 
peer 
[ip-address] reference
load-balance 
class number
[lag-name] reference
log 
custom-event 
[event-number] number
message-string string
parameter1 string
parameter2 string
parameter3 string
parameter4 string
parameter5 string
parameter6 string
parameter7 string
parameter8 string
subject string
test-event 
custom-text string
router string 
isis reference 
ldp-sync-exit 
overload 
max-metric boolean
[seconds] number
run-manual-spf 
mcast-umh-red 
show 
pair 
card number
pair-id number
summary 
pim 
mc-ecmp-rebalance 
threshold number
show 
iom-failures 
detail boolean
system 
script-control 
script-policy 
stop 
all 
owner reference
policy-name reference
security 
secure-boot 
show 
uefi-variables 
card reference
ssh 
generate-keypair 
ecdsa-curve keyword
ed25519 
rsa-key-size number
[save-path] cflash-url

perform command descriptions

perform

Synopsis Perform troubleshooting and debugging
Contextperform
Treeperform
Introduced25.3.R2

Platforms

7705 SAR Gen 2

card [slot-number] number

Synopsis Enter the card list instance
Context perform card number
Treecard
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[slot-number] number
Synopsis Card slot number
Context perform card number
Treecard
Max. range0 to 4294967295

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

chassis [chassis-class] reference chassis-number reference

Synopsis Enter the chassis list instance
Context perform chassis reference chassis-number reference
Treechassis
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[chassis-class] reference
Synopsis Physical chassis
Context perform chassis reference chassis-number reference
Treechassis

Reference

state chassis keyword chassis-number number

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

chassis-number reference
Synopsis Unique index ID for the physical chassis
Contextperform chassis reference chassis-number reference
Treechassis

Reference

state chassis keyword chassis-number number

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

filter

Synopsis Enter the filter context
Context perform filter
Treefilter
Introduced25.3.R2

Platforms

7705 SAR Gen 2

ip-filter [filter-name] reference
Synopsis Enter the ip-filter list instance
Contextperform filter ip-filter reference
Treeip-filter
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[filter-name] reference
Synopsis Name to associate with the IP filter
Context perform filter ip-filter reference
Treeip-filter

Reference

state filter ip-filter filter-name

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

entry [entry-id] reference
Synopsis Enter the entry list instance
Context perform filter ip-filter reference entry reference
Treeentry
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[entry-id] reference
Synopsis ID for the IP filter entry
Context perform filter ip-filter reference entry reference
Treeentry

Reference

state filter ip-filter filter-name entry number

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

activate-primary-action
Synopsis Switch from the secondary to the primary action
Contextperform filter ip-filter reference entry reference activate-primary-action
Treeactivate-primary-action

Description

This command activates the primary action for the specified filter policy entry. If the primary action is already active, the command has no effect. If a secondary action is active, the primary action is activated unless the primary target is down. If the configure filter redirect sticky-dest command is configured, the timer expires.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

ipv6-filter [filter-name] reference
Synopsis Enter the ipv6-filter list instance
Contextperform filter ipv6-filter reference
Treeipv6-filter
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[filter-name] reference
Synopsis Name to associate with the IPv6 filter
Contextperform filter ipv6-filter reference
Treeipv6-filter

Reference

state filter ipv6-filter filter-name

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

entry [entry-id] reference
Synopsis Enter the entry list instance
Context perform filter ipv6-filter reference entry reference
Treeentry
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[entry-id] reference
Synopsis ID for the IPv6 filter entry
Context perform filter ipv6-filter reference entry reference
Treeentry

Reference

state filter ipv6-filter filter-name entry number

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

activate-primary-action
Synopsis Switch from the secondary to the primary action
Contextperform filter ipv6-filter reference entry reference activate-primary-action
Treeactivate-primary-action

Description

This command activates the primary action for the specified filter policy entry. If the primary action is already active, the command has no effect. If a secondary action is active, the primary action is activated unless the primary target is down. If the configure filter redirect sticky-dest command is configured, the timer expires.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

redirect-policy [redirect-policy-name] reference
Synopsis Enter the redirect-policy list instance
Contextperform filter redirect-policy reference
Treeredirect-policy
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[redirect-policy-name] reference
Synopsis Name of the redirect policy
Context perform filter redirect-policy reference
Treeredirect-policy

Reference

state filter redirect-policy named-item

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

activate-best-dest
Synopsis Activate the current best destination
Contextperform filter redirect-policy reference activate-best-dest
Treeactivate-best-dest

Description

This command forces a PBR switch to the best destination selected by the redirect policy when that destination is not currently active as result of sticky destination functionality being enabled for the specified redirect policy. If the configure filter redirect sticky-dest command is configured, the timer expires.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

lag

Synopsis Perform LAG operations
Context perform lag
Treelag
Introduced25.3.R2

Platforms

7705 SAR Gen 2

clear-force
Synopsis Perform LAG clear-force operation
Context perform lag clear-force
Treeclear-force
Introduced25.3.R2

Platforms

7705 SAR Gen 2

lag
Synopsis Perform LAG operation on the specified LAG
Contextperform lag clear-force lag
Treelag
Introduced25.3.R2

Platforms

7705 SAR Gen 2

multi-chassis
Synopsis Enter the multi-chassis context
Contextperform lag clear-force multi-chassis
Treemulti-chassis
Introduced25.3.R2

Platforms

7705 SAR Gen 2

force-active
Synopsis Perform LAG force-active operation
Context perform lag force-active
Treeforce-active
Introduced25.3.R2

Platforms

7705 SAR Gen 2

lag
Synopsis Perform LAG operation on the specified LAG
Contextperform lag force-active lag
Treelag
Introduced25.3.R2

Platforms

7705 SAR Gen 2

multi-chassis
Synopsis Enter the multi-chassis context
Contextperform lag force-active multi-chassis
Treemulti-chassis
Introduced25.3.R2

Platforms

7705 SAR Gen 2

force-standby
Synopsis Perform LAG force-standby operation
Context perform lag force-standby
Treeforce-standby
Introduced25.3.R2

Platforms

7705 SAR Gen 2

lag
Synopsis Perform LAG operation on the specified LAG
Contextperform lag force-standby lag
Treelag
Introduced25.3.R2

Platforms

7705 SAR Gen 2

multi-chassis
Synopsis Enter the multi-chassis context
Contextperform lag force-standby multi-chassis
Treemulti-chassis
Introduced25.3.R2

Platforms

7705 SAR Gen 2

load-balance
Synopsis Perform LAG load-balance operation
Context perform lag load-balance
Treeload-balance
Introduced25.3.R2

Platforms

7705 SAR Gen 2

class number
Synopsis Class used for load balancing
Context perform lag load-balance class number
Treeclass
Range1 to 3
Default1
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

[lag-name] reference
Synopsis LAG name
Contextperform lag load-balance [lag-name] reference
Tree[lag-name]

Reference

state lag lag-interface

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

log

Synopsis Enter the log context
Context perform log
Treelog
Introduced25.3.R2

Platforms

7705 SAR Gen 2

custom-event
Synopsis Send a custom generic log event
Context perform log custom-event
Treecustom-event

Description

When specified, the system sends a custom generic log event. The total length of the message string and all parameter strings must be less than or equal to 2400 characters.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

message-string string
Synopsis Message for the log event
Context perform log custom-event message-string string
Treemessage-string

Description

This command specifies the string for the message field of the log event. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length1 to 2000

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

parameter1 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter1 string
Treeparameter1

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter2 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter2 string
Treeparameter2

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter3 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter3 string
Treeparameter3

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter4 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter4 string
Treeparameter4

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter5 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter5 string
Treeparameter5

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter6 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter6 string
Treeparameter6

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter7 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter7 string
Treeparameter7

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

parameter8 string
Synopsis Custom text of the parameter
Context perform log custom-event parameter8 string
Treeparameter8

Description

This command specifies the string for the parameter. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length0 to 2000
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

subject string
Synopsis Subject of the log event
Context perform log custom-event subject string
Treesubject

Description

This command specifies the string in the subject field of the log event. Embedded double quotes are supported by using the backslash character (\) followed by the double quote character (").

String length1 to 32

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

test-event
Synopsis Send a test log event
Context perform log test-event
Treetest-event
Introduced25.3.R2

Platforms

7705 SAR Gen 2

custom-text string
Synopsis Custom text of the test event message field
Contextperform log test-event custom-text string
Treecustom-text

Description

This command specifies custom text for the message section of the test log event. Embedded double quotes are not supported in the custom-text string. There is no special treatment for or \r sequences. For example, in the custom-text string is output as the backslash character (\) and "n" (the equivalent of ASCII 0x5C and 0x6e).

String length0 to 800
Default
Introduced 25.3.R2

Platforms

7705 SAR Gen 2

router [router-instance] string

Synopsis Enter the router list instance
Contextperform router string
Treerouter
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[router-instance] string
Synopsis Router name or VPRN service name
Context perform router string
Treerouter
MD-CLI defaultBase

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

isis [isis-instance] reference
Synopsis Enter the isis list instance
Context perform router string isis reference
Treeisis
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[isis-instance] reference
Synopsis IS-IS instance
Contextperform router string isis reference
Treeisis
MD-CLI default0

Reference

state router named-item-64 isis number

Notes

This element is part of a list key.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

overload
Synopsis Perform IS-IS overload
Context perform router string isis reference overload
Treeoverload
Introduced25.3.R2

Platforms

7705 SAR Gen 2

[seconds] number
Synopsis Overload duration
Context perform router string isis reference overload [seconds] number
Tree[seconds]
Range60 to 1800

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

mcast-umh-red
Synopsis Display Upstream Multi-Homing info
Context perform router string mcast-umh-red
Treemcast-umh-red
Introduced25.3.R2

Platforms

7705 SAR Gen 2

show
Synopsis Enter the show context
Context perform router string mcast-umh-red show
Treeshow
Introduced25.3.R2

Platforms

7705 SAR Gen 2

pair
Synopsis Enter the pair context
Context perform router string mcast-umh-red show pair
Treepair
Introduced25.3.R2

Platforms

7705 SAR Gen 2

card number
Synopsis Slot number
Contextperform router string mcast-umh-red show pair card number
Treecard
Max. range0 to 4294967295

Notes

The following elements are part of a choice: card, pair-id, or summary.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

pair-id number
Synopsis Pair ID
Contextperform router string mcast-umh-red show pair pair-id number
Treepair-id
Range1 to 1000

Notes

The following elements are part of a choice: card, pair-id, or summary.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

pim
Synopsis Enter the pim context
Context perform router string pim
Treepim

Description

Commands in this context enable tools to perform PIM tasks.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

mc-ecmp-rebalance
Synopsis Perform multicast ECMP rebalance
Context perform router string pim mc-ecmp-rebalance
Treemc-ecmp-rebalance
Introduced25.3.R2

Platforms

7705 SAR Gen 2

threshold number
Synopsis ECMP preference level threshold
Context perform router string pim mc-ecmp-rebalance threshold number
Treethreshold

Description

This command configures a threshold level to force a rebalance of all multicast streams with a priority of less than or equal to the specified value. Selecting the highest value forces the rebalance of all multicast streams.

Range1 to 7
Introduced25.3.R2

Platforms

7705 SAR Gen 2

system

Synopsis Enter the system context
Context perform system
Treesystem
Introduced25.3.R2

Platforms

7705 SAR Gen 2

script-control
Synopsis Enter the script-control context
Contextperform system script-control
Treescript-control
Introduced25.3.R2

Platforms

7705 SAR Gen 2

script-policy
Synopsis Enter the script-policy context
Contextperform system script-control script-policy
Treescript-policy
Introduced25.3.R2

Platforms

7705 SAR Gen 2

stop
Synopsis Stop the execution of scripts
Context perform system script-control script-policy stop
Treestop
Introduced25.3.R2

Platforms

7705 SAR Gen 2

all
Synopsis Stop script execution for all script policies
Contextperform system script-control script-policy stop all
Treeall

Notes

The following elements are part of a mandatory choice: all or (owner and policy-name).

Introduced25.3.R2

Platforms

7705 SAR Gen 2

owner reference
Synopsis Stop script execution for a specific owner
Contextperform system script-control script-policy stop owner reference
Treeowner
DefaultTiMOS CLI

Reference

state system script-control script-policy named-item owner named-item

Notes

The following elements are part of a mandatory choice: all or (owner and policy-name).

Introduced25.3.R2

Platforms

7705 SAR Gen 2

policy-name reference
Synopsis Stop script execution for a specific policy
Contextperform system script-control script-policy stop policy-name reference
Treepolicy-name

Reference

state system script-control script-policy named-item owner named-item

Notes

The following elements are part of a mandatory choice: all or (owner and policy-name).

Introduced25.3.R2

Platforms

7705 SAR Gen 2

security
Synopsis Enter the security context
Context perform system security
Treesecurity
Introduced25.3.R2

Platforms

7705 SAR Gen 2

secure-boot
Synopsis Enter the secure-boot context
Context perform system security secure-boot
Treesecure-boot
Introduced25.3.R2

Platforms

7705 SAR Gen 2

show
Synopsis Enter the show context
Context perform system security secure-boot show
Treeshow
Introduced25.3.R2

Platforms

7705 SAR Gen 2

ssh
Synopsis Perform SSH operations
Context perform system ssh
Treessh
Introduced25.3.R2

Platforms

7705 SAR Gen 2

generate-keypair
Synopsis Generate SSH authentication key pair
Context perform system ssh generate-keypair
Treegenerate-keypair
Introduced25.3.R2

Platforms

7705 SAR Gen 2

ecdsa-curve keyword
Synopsis Elliptic curve of the ECDSA key to be generated
Contextperform system ssh generate-keypair ecdsa-curve keyword
Treeecdsa-curve
Optionssecp256r1, secp384r1, secp521r1
Defaultsecp256r1

Notes

The following elements are part of a mandatory choice: ecdsa-curve, ed25519, or rsa-key-size.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

ed25519
Synopsis Generate an ed25519 key
Context perform system ssh generate-keypair ed25519
Treeed25519

Notes

The following elements are part of a mandatory choice: ecdsa-curve, ed25519, or rsa-key-size.

Introduced25.3.R2

Platforms

7705 SAR Gen 2

rsa-key-size number
Synopsis Length in bits of the RSA key to be generated
Contextperform system ssh generate-keypair rsa-key-size number
Treersa-key-size
Range2048 to 4096
Default3072

Notes

The following elements are part of a mandatory choice: ecdsa-curve, ed25519, or rsa-key-size.

Introduced25.3.R2

Platforms

7705 SAR Gen 2