HyperCollector Configuration CLI

/opt/collector-core/bin/pycollector -h
usage: pycollector [-h] {system,network,source,user} ...

Hypersec Collector CLI Util

positional arguments:
  {system,network,source,user}
    system              System API Settings
    network             Network API Settings
    source              Source Service API Settings
    user                User API Settings

options:
  -h, --help            show this help message and exit
  
/opt/collector-core/bin/pycollector system -h
usage: pycollector system [-h] [--get-hostname] [--set-hostname SET_HOSTNAME] [--get-org-id] [--set-org-id SET_ORG_ID] [--get-site-id] [--set-site-id SET_SITE_ID] [--write-config] [--display-config] [--restore-config RESTORE_CONFIG]

options:
  -h, --help            show this help message and exit
  --get-hostname        get collector hostname
  --set-hostname SET_HOSTNAME
                        set collector hostname
  --get-org-id          get org id
  --set-org-id SET_ORG_ID
                        set org id
  --get-site-id         get site id
  --set-site-id SET_SITE_ID
                        set site id
  --write-config        write yaml config to disk
  --display-config      write yaml config to stdout
  --restore-config RESTORE_CONFIG
                        Restore the collector with the specified yaml config

/opt/collector-core/bin/pycollector network -h
usage: pycollector network [-h] [--get-network] [--set-network] [--get-dns] [--set-dns SET_DNS] [--delete-all-dns] [--get-ntp] [--set-ntp SET_NTP] [--delete-all-ntp] [--mgmt-device MGMT_DEVICE] [--mgmt-ip-address MGMT_IP_ADDRESS] [--mgmt-netmask MGMT_NETMASK] [--mgmt-gateway MGMT_GATEWAY]
                           [--event-device EVENT_DEVICE] [--event-ip-address EVENT_IP_ADDRESS] [--event-netmask EVENT_NETMASK] [--event-gateway EVENT_GATEWAY] [--get-mgmt-intf] [--set-mgmt-intf] [--get-event-intf] [--set-event-intf] [--del-event-intf] [--get-interfaces]

options:
  -h, --help            show this help message and exit
  --get-network         get network settings
  --set-network         set network settings
  --get-dns             get dns servers
  --set-dns SET_DNS     set dns servers
  --delete-all-dns      delete all dns servers
  --get-ntp             get ntp servers
  --set-ntp SET_NTP     set ntp servers
  --delete-all-ntp      delete all ntp servers
  --mgmt-device MGMT_DEVICE
                        ethernet device
  --mgmt-ip-address MGMT_IP_ADDRESS
                        ip address
  --mgmt-netmask MGMT_NETMASK
                        netmask
  --mgmt-gateway MGMT_GATEWAY
                        gateway
  --event-device EVENT_DEVICE
                        ethernet device
  --event-ip-address EVENT_IP_ADDRESS
                        ip address
  --event-netmask EVENT_NETMASK
                        netmask
  --event-gateway EVENT_GATEWAY
                        gateway
  --get-mgmt-intf       get mgmt interface for configurator
  --set-mgmt-intf       update mgmt interface settings
  --get-event-intf      get event interface for configurator
  --set-event-intf      update event interface settings
  --del-event-intf      delete event interface settings
  --get-interfaces      get a list of network interfaces

/opt/collector-core/bin/pycollector source -h
usage: pycollector source [-h] [--list] [--enable ENABLE] [--disable DISABLE]

options:
  -h, --help         show this help message and exit
  --list             List configured sources
  --enable ENABLE    Enable a source
  --disable DISABLE  Disable a source

/opt/collector-core/bin/pycollector user -h
usage: pycollector user [-h] [--passwd PASSWD PASSWD] [--list-active-users] [--list-pending-users] [--enable-user ENABLE_USER] [--disable-user DISABLE_USER] [--generate-otp GENERATE_OTP] [--display-otp DISPLAY_OTP] [--delete-otp DELETE_OTP]

options:
  -h, --help            show this help message and exit
  --passwd PASSWD PASSWD
                        Change password for <user> <new password>
  --list-active-users   List authorized users
  --list-pending-users  List pending users
  --enable-user ENABLE_USER
                        Enable account for <user>
  --disable-user DISABLE_USER
                        Disable account for <user>
  --generate-otp GENERATE_OTP
                        Generate otp for <user>
  --display-otp DISPLAY_OTP
                        Display otp for <user>
  --delete-otp DELETE_OTP
                        Delete otp for <user>