Command line interface

Use this information to understand the usage of some command-line options that are available in Technology Pack Development Tool.

pack_tool

pack-tool command can be run as root user. The script is available in /<pack_dev_tool>/bin directory. Where, <pack_dev_tool> is the directory where Technology Pack Development Tool is extracted.

Usage
Run the following command as root user:
$ bin/pack-tool

--------------------------
    Pack Development Tool v1.0
    --------------------------

    Usage: pack-tool [command] [options]

commands:
  new <pack>        - creates a new pack project
  build [<pack>]    - builds the specified pack project
  clean [<pack>]    - cleans the specified pack project
  validate [<pack>] - validates the specified pack project
  deploy [<pack>]   - deploy the specific pack project
  help              - displays help
Parameters
new
Creates a project workspace to contain the Technology Packs that are developed.
build
Builds and packages the Technology Pack after the development is completed.
clean
Cleans the specified Technology Pack project. If a project name is not specified, it cleans all projects.
validate
Validates that content with in the Technology Packs after the development is complete.
deploy
help
Provides the usage of the pack-tool command.

device-discovery-tool

The device-discovery-tool command is used to run the discovery formulas that are created for your custom Technology Pack. The script is available in /<pack_dev_tool>/bin directory. Where, <pack_dev_tool> is the directory where Technology Pack Development Tool is extracted.
Usage
Run the following command as root user:
$ bin/device-discovery-tool 
--------------------------------
Discovery Device Tool v0.4.0.2
--------------------------------

discovery-device-tool [pack] snmp://[credential]@[host]:[port]?[options]

credential:
  version 1/2c     - [read community string]:[write community string]
  version 3        - [user name]:[authentication]:[encryption]:[context]
authentication:
  md5(password)    - MD5 password
  sha1(password)   - SHA1 password    
  none             - No authentication
encryption:
  des(password)    - DES key
  aes(password)    - AES key
  aes128(password) - AES 128-bit key
  aes192(password) - AES 192-bit key
  aes256(password) - AES 256-bit key
  none             - No encryption
options:
  version          - SNMP Version (2,3). Default is auto-detect
  timeout          - SNMP timeout in milisecond. Default is 5 seconds
  retries          - Number of retries before giving up. Default is 3 times
Parameters
pack
Name of the Technology Pack.
credential
Credentials for two the SNMP versions:
  • version 1/2c - [read community string]:[write community string]
    • read community string: name of the SNMP read community.
    • write community string: name of the SNMP write community.
  • version 3 - [user name]:[authentication]:[encryption]:[context]
    • user name: the username to be used for this SNMP V3 community name.
    • authentication: the password to be used for authentication (MD5 or SHA1) for this SNMP V3 element.
    • encryption: the type of encryption for the privacy password. The following types of encryption are available:
      • 3-DES
      • AES 128
      • AES 192
      • AES 256
    • context: the context name to be used for this SNMP V3 community name.
Host
Hostname of the device associated with this SNMP configuration.
port
The port associated with this SNMP configuration. By default, it is 161.
options
Provide the additional information as follows:
  • version - the SNMP Version (2 or 3) associated with this SNMP configuration.
  • timeout - the length of time (in seconds) to wait for a response from a request. Default is 5 seconds.
  • retries - the number of times that a request is tried again if a request failure. Default is three times

file-collector-tool