Metadata-Version: 1.1
Name: dsms_cli
Version: 1.1.0
Summary: DSMS CLI tool
Home-page: https://bitbucket.org/dsms/dsms_report_cli
Author: Chris Horsley
Author-email: chris.horsley@csirtfoundry.com
License: Apache 2.0
Description: DSMS CLI tool
        --------------------
        
        dsms_cli is a command line interface for exporting reports from a DSMS
        system.
        
        ============
        Installation
        ============
        
        ``pip install dsms-cli``
        
        ========
        Setup
        ========
        
        Before you'll begin, you'll need several settings set as environment variables:
        
        * DSMS_SERVER    (e.g. https://mydsmsserver)
        * DSMS_USER      (e.g. tom)
        * DSMS_PASS      (e.g. ThisIsMyPassword)
        
        =========
        Adding targets
        =========
        
        To add targets, you'll firstly need the ID numbers of the schedules, profiles
        and severities you wish to add. You can do this with::
        
            dsms_cli list schedules
            dsms_cli list profiles
            dsms_cli list severities
        
        Then, you're ready to add targets. For example::
        
            dsms_cli add location --profile=1 --schedule=1 http://example.com
            dsms_cli add file --profile=2 --schedule=1 mysample.exe
        
        For file types, the local file path you specify will be uploaded to DSMS.
        
        =========
        Running reports
        =========
        
        
        You can also run searches of DSMS results using the same filter syntax as the
        web application. For example, to get all active phishing targets, run::
        
            dsms_cli --query="status:Active type:Phishing"
        
        =========
        Report formats
        =========
        
        Reports are generated by Jinja2 templates. If you'd like to add new types of
        reports, you can place these in a separate directory and tell dsms_report where
        to find these using ``dsms_cli --template_dir=[your custom templates]``.
        
        =========
        Further help
        =========
        
        To see all command line switches, you can run::
        
            dsms_cli --help
        
Keywords: DSMS
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
