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 
gnss 
restart-position-survey 
all 
port 
[port] reference
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
mda 
card-slot reference 
mda-slot reference 
ptp-reset 
pcap reference 
capture 
start 
timestamp boolean
url-suffix string
stop 
port reference 
serial 
rs232 
socket reference 
rx 
squelch-reset 
python 
python-script 
protect 
hmac-sha256-key string
input-file string
output-file string
reload 
script 
[name] reference
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
service 
cpipe reference 
sap reference 
cem 
asym-delay-adjust 
ies reference 
ip-transport reference 
remote-host reference 
check-tcp 
vprn reference 
ip-transport reference 
remote-host reference 
check-tcp 
system 
grpc 
custom-proto reference 
reload 
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

SAR Gen 2

card [slot-number] number

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

Platforms

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

SAR Gen 2

chassis [chassis-class] reference chassis-number reference

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

Platforms

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

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

SAR Gen 2

filter

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

Platforms

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

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

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

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

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

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

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

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

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

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

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

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

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

SAR Gen 2

gnss

Synopsis Enter the gnss context
Context perform gnss
Treegnss
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

restart-position-survey
Synopsis Enter the restart-position-survey context
Contextperform gnss restart-position-survey
Treerestart-position-survey
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

port
Synopsis Restart the position survey on the specified GNSS port
Contextperform gnss restart-position-survey port
Treeport

Description

This command performs a restart of the GNSS position survey on the specified GNSS port.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[port] reference
Synopsis GNSS port for the GNSS position survey
Contextperform gnss restart-position-survey port [port] reference
Tree[port]

Reference

state port port

Notes

This element is mandatory.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

lag

Synopsis Enter the lag context
Context perform lag
Treelag
Introduced25.3.R2

Platforms

SAR Gen 2

clear-force
Synopsis Enter the clear-force context
Context perform lag clear-force
Treeclear-force
Introduced25.3.R2

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

force-active
Synopsis Enter the force-active context
Contextperform lag force-active
Treeforce-active
Introduced25.3.R2

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

force-standby
Synopsis Enter the force-standby context
Contextperform lag force-standby
Treeforce-standby
Introduced25.3.R2

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

class number
Synopsis Class used for load balancing
Context perform lag load-balance class number
Treeclass
Range1 to 3

Default

1

Introduced25.3.R2

Platforms

SAR Gen 2

log

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

Platforms

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

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

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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
Introduced25.3.R2

Platforms

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

SAR Gen 2

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

Platforms

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
Introduced25.3.R2

Platforms

SAR Gen 2

mda

Synopsis Enter the mda context
Context perform mda
Treemda
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

card-slot [slot-number] reference
Synopsis Enter the card-slot list instance
Contextperform mda card-slot reference
Treecard-slot
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[slot-number] reference
Synopsis Card slot number
Context perform mda card-slot reference
Treecard-slot

Reference

state card number

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

mda-slot [mda] reference
Synopsis Enter the mda-slot list instance
Contextperform mda card-slot reference mda-slot reference
Treemda-slot
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[mda] reference
Synopsis Card MDA slot
Contextperform mda card-slot reference mda-slot reference
Treemda-slot

Reference

state card number mda number

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

ptp-reset
Synopsis Reset the PTP timing on the specified MDA
Contextperform mda card-slot reference mda-slot reference ptp-reset
Treeptp-reset

Description

This command resets the PTP timing subsystem on the specified MDA.

When a PTP timeReceiver port indicates abnormal or extreme values for the offsetFromMaster or the meanPathDelay, it may be because of the PTP timing subsystem of the MDA on the timeTransmitter or the timeReceiver. This command can be used to reinitialize the timing subsystem on an MDA without impacting traffic.

Note: While this command can be used to remedy such a situation, Nokia recommends to first capture any relevant debug files for Nokia investigation.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

pcap [session-name] reference

Synopsis Enter the pcap list instance
Context perform pcap reference
Treepcap

Description

Commands in this context configure a PCAP instance used for packet capture.

Introduced25.7.R1

Platforms

SAR Gen 2

[session-name] reference
Synopsis PCAP session name for the packet capture
Contextperform pcap reference
Treepcap

Reference

state mirror mirror-dest service-name pcap named-item

Notes

This element is part of a list key.

Introduced25.7.R1

Platforms

SAR Gen 2

capture
Synopsis Enter the capture context
Context perform pcap reference capture
Treecapture

Description

Commands in this context configure the packet capture process for a specified PCAP session.

Introduced25.7.R1

Platforms

SAR Gen 2

start
Synopsis Start PCAP capture
Context perform pcap reference capture start
Treestart

Description

When specified, the system starts the packet capture process and also starts the FTP or TFTP session. If the FTP or TFTP server is unreachable, the command prompt rejects further input until the retry mechanism times out after 24 seconds (four attempts of about six seconds each). If the filename (configured using the configure mirror mirror-dest pcap command) is unchanged between captures, this command overwrites the file content. To avoid this, configure the url-suffix option, the timestamp option, or both, to create a new filename when starting a capture.

Introduced25.7.R1

Platforms

SAR Gen 2

stop
Synopsis Stop PCAP capture
Context perform pcap reference capture stop
Treestop

Description

When specified, the system stops the packet capture process and also stops the FTP or TFTP session. If the FTP or TFTP server is unreachable, the command prompt rejects further input until the retry mechanism times out after 24 seconds (four attempts of about six seconds each).

Introduced25.7.R1

Platforms

SAR Gen 2

port [port-id] reference

Synopsis Enter the port list instance
Context perform port reference
Treeport
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[port-id] reference
Synopsis The port identifier
Context perform port reference
Treeport

Reference

state port port

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

serial
Synopsis Enter the serial context
Context perform port reference serial
Treeserial
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

rs232
Synopsis Enter the rs232 context
Context perform port reference serial rs232
Treers232
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

socket [socket-id] reference
Synopsis Enter the socket list instance
Contextperform port reference serial rs232 socket reference
Treesocket
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[socket-id] reference
Synopsis The socket identifier
Context perform port reference serial rs232 socket reference
Treesocket

Reference

state port port serial rs232 socket number

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

python

Synopsis Enter the python context
Context perform python
Treepython
Introduced26.7.R1

Platforms

SAR Gen 2

python-script
Synopsis Enter the python-script context
Contextperform python python-script
Treepython-script
Introduced26.7.R1

Platforms

SAR Gen 2

protect
Synopsis Convert a Python file into a protected SRPY format
Contextperform python python-script protect
Treeprotect

Description

When invoked, the system converts a normal (unprotected) Python script file into a protected SRPY format using a specified key.

Introduced26.7.R1

Platforms

SAR Gen 2

reload
Synopsis Enter the reload context
Context perform python python-script reload
Treereload

Description

Commands in this context reload and recompile the primary, secondary, and tertiary scripts in the specified Python scripts, in that order. The system uses the first script that comes up.

Executing these commands may update the last modified time for the system configuration.

Introduced26.7.R1

Platforms

SAR Gen 2

router [router-instance] string

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

Platforms

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

SAR Gen 2

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

Platforms

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

SAR Gen 2

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

Platforms

SAR Gen 2

mcast-umh-red
Synopsis Enter the mcast-umh-red context
Contextperform router string mcast-umh-red
Treemcast-umh-red
Introduced25.3.R2

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

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

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

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

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

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

SAR Gen 2

service

Synopsis Enter the service context
Context perform service
Treeservice
Introduced25.10.R1

Platforms

SAR Gen 2

cpipe [service-name] reference
Synopsis Enter the cpipe list instance
Context perform service cpipe reference
Treecpipe
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[service-name] reference
Synopsis Name of Cpipe service to perform actions on
Contextperform service cpipe reference
Treecpipe

Reference

state service cpipe service-name

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

sap [sap-id] reference
Synopsis Enter the sap list instance
Context perform service cpipe reference sap reference
Treesap
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[sap-id] reference
Synopsis SAP ID
Contextperform service cpipe reference sap reference
Treesap

Reference

state service cpipe service-name sap sap

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

ies [service-name] reference
Synopsis Enter the ies list instance
Context perform service ies reference
Treeies
Introduced25.10.R1

Platforms

SAR Gen 2

[service-name] reference
Synopsis IES service to perform actions on
Context perform service ies reference
Treeies

Reference

state service ies service-name

Notes

This element is part of a list key.

Introduced25.10.R1

Platforms

SAR Gen 2

ip-transport [ipt-id] reference
Synopsis Enter the ip-transport list instance
Contextperform service ies reference ip-transport reference
Treeip-transport
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[ipt-id] reference
Synopsis The id of the ip-transport to perform actions on
Contextperform service ies reference ip-transport reference
Treeip-transport

Reference

state service ies service-name ip-transport port

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

remote-host [remote-host-id] reference
Synopsis Enter the remote-host list instance
Contextperform service ies reference ip-transport reference remote-host reference
Treeremote-host
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[remote-host-id] reference
Synopsis The id of the remote-host to perform actions on
Contextperform service ies reference ip-transport reference remote-host reference
Treeremote-host

Reference

state service ies service-name ip-transport port remote-host number

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

vprn [service-name] reference
Synopsis Enter the vprn list instance
Context perform service vprn reference
Treevprn
Introduced25.10.R1

Platforms

SAR Gen 2

[service-name] reference
Synopsis VPRN service to perform actions on
Context perform service vprn reference
Treevprn

Reference

state service vprn service-name

Notes

This element is part of a list key.

Introduced25.10.R1

Platforms

SAR Gen 2

ip-transport [ipt-id] reference
Synopsis Enter the ip-transport list instance
Contextperform service vprn reference ip-transport reference
Treeip-transport
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[ipt-id] reference
Synopsis The id of the ip-transport to perform actions on
Contextperform service vprn reference ip-transport reference
Treeip-transport

Reference

state service vprn service-name ip-transport port

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

remote-host [remote-host-id] reference
Synopsis Enter the remote-host list instance
Contextperform service vprn reference ip-transport reference remote-host reference
Treeremote-host
Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

[remote-host-id] reference
Synopsis The id of the remote-host to perform actions on
Contextperform service vprn reference ip-transport reference remote-host reference
Treeremote-host

Reference

state service vprn service-name ip-transport port remote-host number

Notes

This element is part of a list key.

Introduced26.3.R1

Platforms

7705 SAR-Hx, 7705 SAR-Mx

system

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

Platforms

SAR Gen 2

grpc
Synopsis Enter the grpc context
Context perform system grpc
Treegrpc
Introduced26.7.R1

Platforms

SAR Gen 2

custom-proto [name] reference
Synopsis Enter the custom-proto list instance
Contextperform system grpc custom-proto reference
Treecustom-proto
Introduced26.7.R1

Platforms

SAR Gen 2

[name] reference
Synopsis Customized proto name
Context perform system grpc custom-proto reference
Treecustom-proto

Reference

state system grpc custom-proto named-item

Notes

This element is part of a list key.

Introduced26.7.R1

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

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

SAR Gen 2

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

Default

TiMOS 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

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

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

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

Platforms

SAR Gen 2

ssh
Synopsis Enter the ssh context
Context perform system ssh
Treessh
Introduced25.3.R2

Platforms

SAR Gen 2

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

Platforms

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

Default

secp256r1

Notes

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

Introduced25.3.R2

Platforms

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

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

Default

3072

Notes

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

Introduced25.3.R2

Platforms

SAR Gen 2

[save-path] cflash-url
Synopsis Path to save the result key file
Context perform system ssh generate-keypair [save-path] cflash-url
Tree[save-path]
String length1 to 200

String format

'cflash-url' must start with cf1-4, optional slot A-D, then path (e.g. cf1:/path or cf1-A:/path)

'cflash-url' must have each path segment at most 99 characters

Notes

This element is mandatory.

Introduced25.3.R2

Platforms

SAR Gen 2