Commands

Generate input data template command

$ autodiscovery echo-input-template --help
Usage: autodiscovery echo-input-template [OPTIONS]

  Generate user input example file in the given format

Options:
  --template-format [yml|json]  Format of the generated user input template
                                file
  --save-to-file TEXT           File to save generated user input template
                                file
  --help                        Show this message and exit.

Generate an additional vendors configuration template command

$ autodiscovery echo-vendors-configuration-template --help
Usage: autodiscovery echo-vendors-configuration-template [OPTIONS]

  Generate vendors configuration example file in the given format

Options:
  --template-format [json]  Format of the generated user input template file
  --save-to-file TEXT       File to save generated user input template file
  --help                    Show this message and exit.

Generate excel report template command

$ autodiscovery echo-excel-report-template --help
Usage: autodiscovery echo-excel-report-template [OPTIONS]

  Generate .xlsx report example file for the "run-from-report" command

Options:
  --save-to-file TEXT  File to save generated template file  [required]
  --help               Show this message and exit.

Generate excel connection report template command

$ autodiscovery echo-excel-connections-report-template --help
Usage: autodiscovery echo-excel-connections-report-template 
           [OPTIONS]

  Generate .xlsx report example file for the "connect-ports" command

Options:
  --save-to-file TEXT  File to save generated user input template file
                       [required]
  --help               Show this message and exit.

Run autodiscovery command and generate report for the discovered devices

$ autodiscovery run --help
Usage: autodiscovery run [OPTIONS]

  Run Auto discovery command with given arguments from the input file

Options:
  --input-file TEXT              Input file with devices IPs and other
                                 configuration data. Can be generated with a
                                 'echo-input-template' command  [required]
  --config-file TEXT             Vendors configuration file with additional
                                 data. Can be generated with a 'echo-vendors-
                                 configuration-template' command
  --log-file TEXT                File name for logs
  --report-file TEXT             File name for generated report
  --report-type [excel|console]  Type for generated report
  --offline                      Generate report without creation of any
                                 Resource on the CloudShell
  --autoload / --no-autoload     Whether autoload discovered resource on the
                                 CloudShell or not
  --help                         Show this message and exit.

Run autodiscovery command from the generated report

$ autodiscovery run-from-report --help
Usage: autodiscovery run-from-report [OPTIONS]

  Create and autoload CloudShell resources from the generated report

Options:
  --input-file TEXT           Input file with CloudShell configuration data.
                              Can be generated with a 'echo-input-template'
                              command  [required]
  --config-file TEXT          Vendors configuration file with additional data.
                              Can be generated with a 'echo-vendors-
                              configuration-template' command
  --log-file TEXT             File name for logs
  --report-file TEXT          File name of the report to run from  [required]
  --autoload / --no-autoload  Whether autoload discovered resource on the
                              CloudShell or not
  --help                      Show this message and exit.

Get current version of the cloudshell-autodiscovery tool

$ autodiscovery version --help
Usage: autodiscovery version [OPTIONS]

  Get version of the CloudShell Autodiscovery CLI tool

Options:
  --help  Show this message and exit.

Run autodiscovery command to establish physical connection between ports

$ autodiscovery connect-ports --help
Usage: autodiscovery connect-ports [OPTIONS]

  Create connections between CloudShell Port resources specified in the
  connection file

Options:
  --input-file TEXT               Input file with CloudShell configuration
                                  data. Can be generated with a 'echo-input-
                                  template' command  [required]
  --connections-report-file TEXT  File with port connections data. Can be
                                  generated with 'echo-excel-connections-
                                  report-template' command  [required]
  --log-file TEXT                 File name for logs
  --help                          Show this message and exit.