Package Documentation
Storm Package: synapse-psl
The following Commands are available from this package. This documentation is generated for version 0.2.0 of the package.
Storm Commands
This package implements the following Storm Commands.
psl.config.add
Add a Synapse-PSL configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add a global configuration
psl.config.add global_config
// Add a configuration for the current user with a custom tag prefix
psl.config.add --scope self my_config --tag-prefix my.psl.suffix
Usage: psl.config.add [options] <name>
Options:
--help : Display the command usage.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--tag-prefix <tag_prefix> : The tag prefix to use when tagging ingested inet:fqdn nodes. (default: rep.psl.suffix)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.psl.adminpower-ups.psl.user
psl.config.del
Delete a Synapse-PSL configuration.
Examples:
// Delete the "fooconfig" configuration
psl.config.del fooconfig
Usage: psl.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.psl.adminpower-ups.psl.user
psl.config.list
Display the list of Synapse-PSL configurations you have access to.
Usage: psl.config.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.psl.adminpower-ups.psl.user
psl.config.migrate
Migrate options for all Synapse-PSL configurations.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Migrate the tag prefix for all configurations
psl.config.migrate --tag-prefix my.psl.suffix
Usage: psl.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when tagging ingested inet:fqdn nodes. (default: None)
The command is accessible to users with one or more of the following permissions:
power-ups.psl.admin
psl.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
psl.config.show
// Show a configuration by name
psl.config.show myconfig
Usage: psl.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.psl.adminpower-ups.psl.user
psl.config.update
Update the configuration of a defined Synapse-PSL configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the permission level for user "myuser" to "admin" on the "fooconfig"
// configuration
psl.config.update fooconfig --perm user myuser admin
// Do not verify the SSL certificate when connecting to "fooconfig"
psl.config.update fooconfig --ssl-verify (false)
// Change the tag prefix used by the "fooconfig" configuration
psl.config.update fooconfig --tag-prefix my.psl.suffix
// Change the name of the "fooconfig" configuration to "barconfig"
psl.config.update fooconfig --name barconfig
Usage: psl.config.update [options] <config>
Options:
--help : Display the command usage.
--perm <perm> : Set the permission level for a user or role on this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level, or None to remove the permission.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when tagging ingested inet:fqdn nodes. (default: None)
--name <name> : Rename the configuration. (default: None)
Arguments:
<config> : The name of the configuration to modify.
The command is accessible to users with one or more of the following permissions:
power-ups.psl.adminpower-ups.psl.user
psl.ingest
Download and ingest the Public Suffix List.
This command will download the Public Suffix List and create inet:fqdn
nodes with :issuffix=True for the listed suffixes.
Examples:
// Ingest the Public Suffix List and yield the created nodes
psl.ingest --yield
// Ingest the Public Suffix List without applying tags
psl.ingest --no-tags
// Create a cron job to update the Public Suffix List every day
cron.add --name psl.ingest --hour 5 { psl.ingest }
Endpoints:
(user-configured base URL)
/list/public_suffix_list.dat: Endpoint for downloading the Public Suffix List.
Usage: psl.ingest [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--yield : Yield the newly created nodes.
--no-tags : Do not apply tags to created nodes.
--config <config> : Override the default config with the provided name.
The command is accessible to users with one or more of the following permissions:
power-ups.psl.adminpower-ups.psl.user
Storm Modules
This package does not export any Storm APIs.