docs: updated examples in cmd

Author: davidallendj

cmd/collect.go

@@ -39,7 +39,14 @@ var CollectCmd = &cobra.Command{
   // run a collect using secrets from the secrets manager
   export MASTER_KEY=$(magellan secrets generatekey)
   magellan secrets store $node_creds_json -f nodes.json
-  magellan collect -o nodes.yaml`,
+  magellan collect -o nodes.yaml
+
+  // Take the output of 'scan' and input directly into 'collect'
+  magellan scan --subnet 172.18.0.0/24 --port 5000 -l info -i -F json | ./magellan collect -f json --show-output -i
+  
+  // Complete flow combined as a single line
+  magellan scan --subnet 172.18.0.0/24 --port 5000 -l info -i -F json | ./magellan collect -f json --show-output -i | magellan send https://smd.example.com
+  `,
 	Short: "Collect system information by interrogating BMC node",
 	Long:  "Send request(s) to a collection of hosts running Redfish services found stored from the 'scan' in cache.\nSee the 'scan' command on how to perform a scan.",
 	Run: func(cmd *cobra.Command, args []string) {

cmd/scan.go

@@ -51,6 +51,9 @@ var ScanCmd = &cobra.Command{
   // assumes subnet using HTTPS and port 443 with specified CIDR
   magellan scan --subnet 10.0.0.0/16 -i
 
+  // same as above example but output is in JSON without caching
+  magellan scan --subnet 10.0.0.0/16 -i -f json --disable-cache
+
   // assumes subnet using HTTP and port 5000 similar to 192.168.0.0/16
   magellan scan --subnet 192.168.0.0 --protocol tcp --scheme https --port 5000 --subnet-mask 255.255.0.0