Utility for managing Signal Sciences sites
Project description
Signal Sciences Site Management Tool
Installation
$ pip3 install sigsci_site_manager
Usage
Main Usage
$ sigsci_site_manager --help
usage: sigsci_site_manager [-h] [--corp CORP] [--user [USERNAME]]
[--password [PASSWORD] | --token [APITOKEN]]
{list,deploy,backup,clone} ...
Signal Sciences site management
optional arguments:
-h, --help show this help message and exit
--corp CORP, -c CORP Signal Sciences corp name. If omitted will try to use
value in $SIGSCI_CORP.
--user [USERNAME], -u [USERNAME]
Signal Sciences username. If omitted will try to use
value in $SIGSCI_EMAIL.
--password [PASSWORD], -p [PASSWORD]
Signal Sciences password. If omitted will try to use
value in $SIGSCI_PASSWORD
--token [APITOKEN], -t [APITOKEN]
Signal Sciences API token. If omitted will try to use
value in $SIGSCI_API_TOKEN
Commands:
{list,deploy,backup,clone,merge}
list List sites
deploy Deploy a new site from a file
backup Backup a site to a file
clone Clone an existing site to a new site
merge Merge a site onto another
List Command
$ sigsci_site_manager list --help
usage: sigsci_site_manager list [-h] [--filter PATTERN]
optional arguments:
-h, --help show this help message and exit
--filter PATTERN Filter site names using a wildcard pattern
Backup Command
$ sigsci_site_manager backup --help
usage: sigsci_site_manager backup [-h] --name NAME --out FILENAME
optional arguments:
-h, --help show this help message and exit
--name NAME, -n NAME Site name
--out FILENAME, -o FILENAME
File to save backup to
Deploy Command
$ sigsci_site_manager deploy --help
usage: sigsci_site_manager deploy [-h] --name NAME
[--display-name "Display Name"] --file
FILENAME [--dry-run]
[--include CATEGORY_LIST | --exclude CATEGORY_LIST]
optional arguments:
-h, --help show this help message and exit
--name NAME, -n NAME Identifying name of the site
--display-name "Display Name", -N "Display Name"
Display name of the site
--file FILENAME, -f FILENAME
Name of site file
--dry-run Print actions without making any changes
--include CATEGORY_LIST
CSV list of categories to include in the merge.
Options: RULE_LISTS, CUSTOM_SIGNALS, REQUEST_RULES,
SIGNAL_RULES, TEMPLATED_RULES, CUSTOM_ALERTS,
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
--exclude CATEGORY_LIST
CSV list of categories to include in the merge.
Options: RULE_LISTS, CUSTOM_SIGNALS, REQUEST_RULES,
SIGNAL_RULES, TEMPLATED_RULES, CUSTOM_ALERTS,
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
Clone Command
$ sigsci_site_manager clone --help
usage: sigsci_site_manager clone [-h] --src SITE --dest SITE
[--display-name "Display Name"] [--dry-run]
[--include CATEGORY_LIST | --exclude CATEGORY_LIST]
optional arguments:
-h, --help show this help message and exit
--src SITE, -s SITE Site to clone from
--dest SITE, -d SITE Site to clone to
--display-name "Display Name", -N "Display Name"
Display name of the new site
--dry-run Print actions without making any changes
--include CATEGORY_LIST
CSV list of categories to include in the merge.
Options: RULE_LISTS, CUSTOM_SIGNALS, REQUEST_RULES,
SIGNAL_RULES, TEMPLATED_RULES, CUSTOM_ALERTS,
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
--exclude CATEGORY_LIST
CSV list of categories to include in the merge.
Options: RULE_LISTS, CUSTOM_SIGNALS, REQUEST_RULES,
SIGNAL_RULES, TEMPLATED_RULES, CUSTOM_ALERTS,
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
Merge Command
$ sigsci_site_manager merge --help
usage: sigsci_site_manager merge [-h] --dest SITE
[--src SITE | --file FILENAME] [--dry-run]
[--include CATEGORY_LIST | --exclude CATEGORY_LIST]
[--yes]
optional arguments:
-h, --help show this help message and exit
--dest SITE, -d SITE Site to merge onto (accepts wildcard pattern)
--src SITE, -s SITE Site to merge from
--file FILENAME, -f FILENAME
Name of site file to merge from
--dry-run Print actions without making any changes
--include CATEGORY_LIST
CSV list of categories to include in the merge.
Options: RULE_LISTS, CUSTOM_SIGNALS, REQUEST_RULES,
SIGNAL_RULES, TEMPLATED_RULES, CUSTOM_ALERTS,
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
--exclude CATEGORY_LIST
CSV list of categories to include in the merge.
Options: RULE_LISTS, CUSTOM_SIGNALS, REQUEST_RULES,
SIGNAL_RULES, TEMPLATED_RULES, CUSTOM_ALERTS,
SITE_MEMBERS, INTEGRATIONS, ADVANCED_RULES
--yes, -y Automatic yes to prompts
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sigsci_site_manager-1.1.0.tar.gz
(12.0 kB
view hashes)
Built Distribution
Close
Hashes for sigsci_site_manager-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 004a39b9ed3ea92d311c527c9cb0aba3a98af3dd48bb849ceaa8499dcf6b8e40 |
|
MD5 | 0c47f4535007d9d4c6d07ad7e9c845f6 |
|
BLAKE2b-256 | 74008b4c8baff379dcf0bd07857a78ba5a4eaa785093f6af6163b27ee881a6ea |
Close
Hashes for sigsci_site_manager-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc12f0b001ce9ddec00fbdafe840887fd9714289ef99fbb44cc647065e12c439 |
|
MD5 | a666ff275aee7dc78e67a73be62e6ced |
|
BLAKE2b-256 | afea35cf000378c67d44c17f3c8cc8144d90df2a3983beb207ee492c2a936ab1 |