The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

sc-api - Tenable.sc (SecurityCenter) API command line interface

SYNOPSIS

    sc-api [COMMAND] [OPTIONS]

    Commands:

        analysis
        credential
        device-info
        feed
        file
        notification
        plugin
        plugin-family
        policy
        report
        repository
        scan
        scan-result
        scanner
        status
        system
        user
        zone

    Options:
        --help              Brief help message
        --man               Full documentation
        --verbose           Print more info during run

        --hostname          Tenable.sc (SecurityCenter) host/IP address
        --username          Username
        --password          Password

        --access_key        Access Key
        --secrey_key        Secret Key

        --ssl_cert_file     Certificate file
        --ssl_cert_key      Certificate private key
        --ssl_password      Private key password (optional)

        --config [FILE]     Configuration file

        --format [TYPE]     Output format (default: json)
                                - json (require JSON or JSON::XS modules)
                                - dumper (Data::Dumper)
                                - csv (Comma Separated Values)
                                - tsv (Tab Separated Values)
                                - table
                                - yaml (require YAML or YAML::XS modules)

        --table             Table output format (--format=table)
        --csv               CSV output format (--format=csv)
        --tsv               TSV output format (--format=tsv)
        --dumper            Data::Dumper format (--format=dumper)
        --json              JSON output format (--format=json)
        --yaml              YAML output format (--format=yaml)

    Examples:

        Download a plugin from Tenable.sc:

            sc-api plugin download id=19506

        View Tenable.sc policy:

            sc-api policy get id=1

DESCRIPTION

sc-api Tenable.sc (SecurityCenter) API command line interface.

COMMANDS

analysis

See Net::SecurityCenter::API::Analysis class.

credential

See Net::SecurityCenter::API::Analysis class.

device-info

See Net::SecurityCenter::API::DeviceInfo class.

feed

See Net::SecurityCenter::API::Feed class.

file

See Net::SecurityCenter::API::File class.

notification

See Net::SecurityCenter::API::Notification class.

plugin

See Net::SecurityCenter::API::Plugin class.

plugin-family

See Net::SecurityCenter::API::PluginFamily class.

policy

See Net::SecurityCenter::API::Policy class.

report

See Net::SecurityCenter::API::Report class.

repository

See Net::SecurityCenter::API::Repository class.

scan

See Net::SecurityCenter::API::Scan class.

scan-result

See Net::SecurityCenter::API::ScanResult class.

scanner

See Net::SecurityCenter::API::Scanner class.

status

See Net::SecurityCenter::API::Scanner class.

system

See Net::SecurityCenter::API::System class.

ticket

See Net::SecurityCenter::API::Ticket class.

user

See Net::SecurityCenter::API::User class.

zone

See Net::SecurityCenter::API::Zone class.

OUTPUT FORMATS

sc-api can export the Tenable.sc API output in different format (CSV, TSV, Table, JSON, YAML, Dumper).

CONFIGURATION FILE

Sample configuration file:

    [SecurityCenter]
    hostname = tenable-sc.example.org:443
    username = secman
    password = mypass

Sample configuration file with API Authentication:

    [SecurityCenter]
    hostname = tenable-sc.example.org:443
    secret_key = <SECRET KEY>
    access_key = <ACCESS KEY>

Sample configuration file with SSL Mutual-Auth:

    [SecurityCenter]
    hostname      = tenable-sc.example.org:443
    username      = secman
    password      = mypass
    ssl_cert_file = /path/my-cert.crt
    ssl_key_file  = /path/my-private.key
    ssl_password  = <SECRET>

AUTHOR

Giuseppe Di Terlizzi

COPYRIGHT AND LICENSE

Copyright © 2018-2023 Giuseppe Di Terlizzi

You may use and distribute this module according to the same terms that Perl is distributed under.