Argus Toolbelt¶
Argus has, for a long time, had a large number of separate “tools”, or python scripts, used to interact with the API and perform a number of different tasks - some automated, and some not so automated.
Toolbelt provides a framework to unify tools like these under one command. building commandline tools with Argus’ API. This is done via a plugin approach.
We aim to make it as simple as possible for developers to write and run their plugins without having to deal with authentication, HTTP requests, argument handling and commandline formatting.
Installation¶
To install the framework run pip install argus-toolbelt
.
This will install 3 packages to your python install and
start a setup that creates the settings-file required by argus_cli.
The packages installed are:
- argus_api: Generates and provides functions for communicating with Argus API
- argus_cli: Provides a standardized framework for writing commandline scripts that interact with Argus
- argus_plugins: Default set of plugins loaded by
argus_cli
, and instructions on how to add your own
The setup script can be run at any time by running toolbelt-setup
.
This script should be in your PATH
after installation.
Usage¶
After the script is installed it can be run as argus-cli
anywhere on the system.
The syntax for running a command is argus-cli <plugin> <command> [arguments]
If you for example want to check statistics for all cases, you can write: argus-cli cases statistics
,
but for a full list of commands, try argus-cli --help
Contents:
- Argus CLI Documentation
- Argus Plugins
- Argus API
- Using Argus API on the command-line
- Using Argus API in your scripts
- Subpackages
- argus_api.exceptions package
- argus_api.helpers package
- argus_api.parsers package
- argus_api.api: Autogenerated API
- api.alarms.v1 package
- api.assets.v1 package
- api.authentication.v1 package
- api.cases.v1 package
- api.cases.v2 package
- api.currentuser.v1 package
- api.customernetworks.v1 package
- api.customers.v1 package
- api.datastores.v1 package
- api.documents.v1 package
- api.eventfilters.v1 package
- api.events.v1 package
- api.pdns.v3 package
- api.permissions.v1 package
- api.reports.v1 package
- api.reputation.v1 package
- api.sampledb.v1 package
- api.sensors.v1 package
- api.system.components.code.v1 package
- api.system.components.configuration.v1 package
- api.system.components.runtime.v1 package
- api.system.notification.v1 package
- api.system.services.v1 package
- api.users.v1 package
- api.world.v1 package
- api.alarms.v1.test_helpers package
- api.alarms.v1.test_helpers.alarm package
- api.alarms.v1.test_helpers.category package
- api.alarms.v1.test_helpers.signature package
- api.assets.v1.test_helpers package
- api.assets.v1.test_helpers.application package
- api.assets.v1.test_helpers.businessprocess package
- api.assets.v1.test_helpers.host package
- api.assets.v1.test_helpers.scan package
- api.assets.v1.test_helpers.service package
- api.assets.v1.test_helpers.vulnerability package
- api.authentication.v1.ldap.test_helpers package
- api.authentication.v1.ldap.test_helpers.ldap_authenticate package
- api.authentication.v1.password.test_helpers package
- api.authentication.v1.password.test_helpers.password_authenticate package
- api.authentication.v1.radius.test_helpers package
- api.authentication.v1.radius.test_helpers.radius_authenticate package
- api.authentication.v1.signature.test_helpers package
- api.authentication.v1.signature.test_helpers.signature_authenticate package
- api.authentication.v1.sms.test_helpers package
- api.authentication.v1.sms.test_helpers.sms_authenticate package
- api.authentication.v1.test_helpers package
- api.authentication.v1.test_helpers.apikey package
- api.authentication.v1.test_helpers.constrain package
- api.authentication.v1.test_helpers.impersonate package
- api.authentication.v1.test_helpers.logout package
- api.authentication.v1.test_helpers.methods package
- api.authentication.v1.test_helpers.session package
- api.authentication.v1.test_helpers.totp package
- api.authentication.v1.user.test_helpers package
- api.authentication.v1.user.test_helpers.user_apikey package
- api.cases.v1.test_helpers package
- api.cases.v1.test_helpers.case package
- api.cases.v1.test_helpers.servicetypes package
- api.cases.v2.test_helpers package
- api.cases.v2.test_helpers.case package
- api.cases.v2.test_helpers.category package
- api.cases.v2.test_helpers.service package
- api.cases.v2.test_helpers.servicesubscription package
- api.currentuser.v1.permission.test_helpers package
- api.currentuser.v1.permission.test_helpers.permission package
- api.currentuser.v1.test_helpers package
- api.currentuser.v1.test_helpers.authmethods package
- api.currentuser.v1.test_helpers.functions package
- api.currentuser.v1.test_helpers.picture package
- api.currentuser.v1.test_helpers.prefs package
- api.currentuser.v1.test_helpers.user package
- api.customernetworks.v1.test_helpers package
- api.customernetworks.v1.test_helpers.network package
- api.customers.v1.test_helpers package
- api.customers.v1.test_helpers.customer package
- api.customers.v1.test_helpers.location package
- api.datastores.v1.store.test_helpers package
- api.datastores.v1.store.test_helpers.store package
- api.datastores.v1.test_helpers package
- api.datastores.v1.test_helpers.descriptor package
- api.documents.v1.customer.test_helpers package
- api.documents.v1.customer.test_helpers.customer package
- api.documents.v1.document.test_helpers package
- api.documents.v1.document.test_helpers.document package
- api.documents.v1.folder.test_helpers package
- api.documents.v1.folder.test_helpers.folder_root package
- api.eventfilters.v1.test_helpers package
- api.eventfilters.v1.test_helpers.filter package
- api.events.v1.test_helpers package
- api.events.v1.test_helpers.aggregated package
- api.events.v1.test_helpers.nids package
- api.events.v1.test_helpers.payload package
- api.events.v1.test_helpers.pcap package
- api.pdns.v3.test_helpers package
- api.pdns.v3.test_helpers.search package
- api.permissions.v1.function.test_helpers package
- api.permissions.v1.function.test_helpers.function package
- api.reports.v1.test_helpers package
- api.reports.v1.test_helpers.job package
- api.reports.v1.test_helpers.plan package
- api.reports.v1.test_helpers.schedule package
- api.reports.v1.test_helpers.search package
- api.reports.v1.test_helpers.template package
- api.reputation.v1.calculated.test_helpers package
- api.reputation.v1.calculated.test_helpers.calculated_domain package
- api.reputation.v1.override.test_helpers package
- api.reputation.v1.override.test_helpers.override_domain package
- api.reputation.v1.test_helpers package
- api.reputation.v1.test_helpers.observation package
- api.reputation.v1.test_helpers.role package
- api.reputation.v1.test_helpers.source package
- api.sampledb.v1.submission.test_helpers package
- api.sampledb.v1.submission.test_helpers.submission_search package
- api.sampledb.v1.test_helpers package
- api.sampledb.v1.test_helpers.sample package
- api.sensors.v1.test_helpers package
- api.sensors.v1.test_helpers.sensor package
- api.sensors.v1.test_helpers.status package
- api.system.components.code.v1.test_helpers package
- api.system.components.code.v1.test_helpers.artifact package
- api.system.components.code.v1.test_helpers.profile package
- api.system.components.code.v1.test_helpers.vacuum package
- api.system.components.configuration.v1.test_helpers package
- api.system.components.configuration.v1.test_helpers.host package
- api.system.components.configuration.v1.test_helpers.instance package
- api.system.components.configuration.v1.test_helpers.template package
- api.system.components.runtime.v1.host.cachedconfigurations.test_helpers package
- api.system.components.runtime.v1.host.cachedconfigurations.test_helpers.host_cachedconfigurations_clear package
- api.system.components.runtime.v1.instance.test_helpers package
- api.system.components.runtime.v1.instance.test_helpers.instance_install package
- api.system.components.runtime.v1.property.test_helpers package
- api.system.components.runtime.v1.property.test_helpers.property package
- api.system.components.runtime.v1.test_helpers package
- api.system.components.runtime.v1.test_helpers.invoke package
- api.system.components.runtime.v1.test_helpers.lookup package
- api.system.components.runtime.v1.test_helpers.properties package
- api.system.components.runtime.v1.test_helpers.status package
- api.system.components.runtime.v1.test_helpers.task package
- api.system.notification.v1.test_helpers package
- api.system.notification.v1.test_helpers.events package
- api.system.notification.v1.test_helpers.rule package
- api.system.services.v1.test_helpers package
- api.system.services.v1.test_helpers.status package
- api.users.v1.test_helpers package
- api.users.v1.test_helpers.group package
- api.users.v1.test_helpers.subject package
- api.users.v1.test_helpers.user package
- api.world.v1.test_helpers package
- api.world.v1.test_helpers.timezone package
- Module contents
- argus_api.argus module
- argus_api.schema module
- Module contents
earch`