NSX CLI Guide

start invocation runbook <runbook-id> [runbook-arg <runbook-param>]

Start an invocation of a specified runbook. You can also pass arguments for the certain invocation. The specification of runbook parameters can vary as per individual runbook and can be found by command `get runbook help`. To specify a parameter "foo" with value "bar", the argument can be written in the following syntax: `--foo bar`

Parameters:

Option Description
<runbook-id> Runbook ID
<runbook-param> Runbook parameters


Example:

nsx > start invocation runbook EdgeDpBfd runbook-arg --src_ip 212.149.55.92 --dst_ip 212.149.55.93 Runbook Invocation Report Invocation ID : a4774982-17da-40ee-9282-e1c2dd8cb1de Timestamp : 2023-11-01 02:20:51 System Info Host Name : nsx OS Name : Linux OS Version : 5.15.123-nn2-server Arch : x86_64 Runbook Info Runbook ID : EdgeDpBfd Version : 2.0 Publisher : VMware, Inc. Report Type : VALID Conclusion : Edge BFD session (212.149.55.92 <-> 212.149.55.93) never went down. Recommendation : No action needs to be taken. Artifact Bundle : /a4774982-17da-40ee-9282-e1c2dd8cb1de.offline.tar.gz Steps Step Number : 1 Step Action : Fetch BFD session Step Result : Edge BFD session (212.149.55.92 <-> 212.149.55.93) is (up), last remote state: (up), local diag: (No Diagnostic), last remote diag: (No Diagnostic), last down time: (N/A), local down reason: (No Diagnostic), remote down reason: (No Diagnostic). Step Number : 2 Step Action : Fetch BFD session stats Step Result : Edge BFD session (212.149.55.92 <-> 212.149.55.93) never went down.

Mode:

Basic

Availability: