Skip to main content

host commands

Host commands manage tester hosts.

host add​

host add command adds a new test host.

Usage​

host add [options] <host>

Arguments​

  • host: IP address or hostname

Options​

  • -t, --tag <tag>: add tags to a host
  • -u, --user <user> sets username. default to "root"
  • -p, --password <password>: sets password. if not provided, a user input will be requested.
  • -v, --frameworkVersion <version>: download a specific framework version. default: latest
  • --throwOnError: throw error on failure

host remove​

Usage​

host remove [options] <target>

Arguments​

  • target: selects a host or hosts using a hostname or a tag.
    • all can be used to select all hosts.

Options​

  • --throwOnError: throw error on failure

host assign​

host assign command adds a tag or tags to a target host or hosts.

Usage​

host assign [options] <target> <tags>

Arguments​

  • target: selects a host or hosts using a hostname or a tag.
    • all can be used to select all hosts.
  • tags: new tags to be added to the selected target host or hosts.
    • multiple tags can be used when separated by commas.

Options​

  • -q, --quiet: mute console outputs
  • --throwOnError: throw error on failure

host unassign​

host unassign command removes a tag or tags from a target host or hosts.

Usage​

host unassign [options] <target> <tags>

Arguments​

  • target: selects a host or hosts using a hostname or a tag.
    • all can be used to select all hosts.
  • tags: existing tags to be removed from the selected target host or hosts.
    • multiple tags can be used when separated by commas.

Options​

  • -q, --quiet: mute console outputs
  • --throwOnError: throw error on failure

host list​

host list command lists registered hosts.

Usage​

host list [options]

Options​

  • -t, --target <target>: show status for specified target
  • -i, --idle: show only idle ports
  • -q, --quiet: mute console outputs
  • --throwOnError: throw error on failure

host status​

host status command display status of a target host or hosts.

Usage​

host status [options] <target>

Arguments​

  • target: selects a host or hosts using a hostname or a tag.
    • all can be used to select all hosts.

Options​

  • --throwOnError: throw error on failure

host update​

host update command updates ioBuster framework from the target host or hosts.

Usage​

host update [options] <target>

Arguments​

  • target: selects a host or hosts using a hostname or a tag.
    • all can be used to select all hosts.

Options​

  • -v, --frameworkVersion <version>: download a specific framework version. default: latest
  • -f, --frameworkFile <filename>: framework file to deploy
  • -r, --rescan: rescans ports
  • --useDebugBin: use a debug framework
  • --throwOnError: throw error on failure

host reserve​

host reserve command reserves idle hosts.

Usage​

host reserve [options]

Options​

  • -l, --limit <limit>: number of hosts to reserve
  • -t, --tag <tag>: tag to add
  • --throwOnError: throw error on failure