Skip to content

Latest commit

 

History

History
182 lines (114 loc) · 5.2 KB

README.md

File metadata and controls

182 lines (114 loc) · 5.2 KB

DISCLAIMER:

EARLY RELEASE, SUBJECT TO CHANGE IN THE FUTURE.

About:

alertlogic-cli is a Command Line Client for Alertlogic services.

Requirements:

  1. python 2.7+ (3.x not supported)
  2. requests library

Installation:

The easiest way to install alertlogic-cli is using pip:

pip install alertlogic-cli

Configuration:

alertlogic-cli uses a config file: ~/.alertlogic/config and a credentials file: ~/.alertlogic/credentials They must be both ini style files where each section represents a profile.

Config profile can have these fields:

  • api_endpoint: either uk or us (required)
  • account_id: only for managed accounts, uses this account instead of user's account (uuid) (optional)
  • deployment_id: default for deployment operations (uuid) (optional)

Credentials profile can have these fields:

  • username: your alertlogic cloudinsight username (required)
  • password: your alertlogic cloudinsight password (required)

Example config:

[default]
api_endpoint = us
account_id = 123089

Example credentials:

[default]
username = [email protected]
password = ultr4s3cr3t

Usage

Alert Logic CLI currently supports the following commands and subcommands:

  1. deployment - groups the deployment related operations

    Options available:

    • --deployment_id ENVIRONMENT_ID - to point on a customer deployment

    • --account_id ACCOUNT_ID - to point at a customer account

    Operations available:

    • set_deployment_mode - changes deployment deployment mode between readonly or manual

      Options available:

      --mode {readonly,automatic} - deployment mode needed

      Example:

      $ alertlogic-cli --deployment_id 00000000-0000-0000-0000-000000000000 deployment set_deployment_mode --mode readonly

    • get_deployment_mode - shows deployment deployment mode:

      Example:

      $ alertlogic-cli --deployment_id 00000000-0000-0000-0000-000000000000 deployment get_deployment_mode

    • get_deployment_status - gets deployment status for a given deployment

      Example:

      $ alertlogic-cli --deployment_id 00000000-0000-0000-0000-000000000000 deployment get_deployment_status

    • list_deployed_resources - lists security infrastructure resources deployed

      Example:

      $ alertlogic-cli --deployment_id 00000000-0000-0000-0000-000000000000 deployment list_deployed_resources

    • list_scan_queues - lists hosts in scan queues for a given deployment

      Options available:

      --vpc_key VPC_KEY - filter hosts for a given VPC

      Example:

      $ alertlogic-cli --deployment_id 00000000-0000-0000-0000-000000000000 deployment list_scan_queues

    • scan_host - puts a host in the immediate scan queue

      Options available:

      --host_key HOST_KEY - a host to put in the queue

      Example:

      $ alertlogic-cli --deployment_id 00000000-0000-0000-0000-000000000000 deployment scan_host --host_key /aws/us-east-1/host/i-00000000000000000

    • set_subnet - Sets a predefined security subnet to deploy infrastructure in. For guided mode deployments

      Options available:

      --provider_type PROVIDER_TYPE - Provider type for subnet (aws/azure) (Required)

      --provider_id PROVIDER_ID - Provider id for subnet (Required)

      --vpc_id VPC_ID - VPC id that subnet is within (Required)

      --subnet_id SUBNET_ID - Subnet in which to deploy security infrastructure (Required)

      Example:

      $ alertlogic-cli --account_id 12345678 deployment set_subnet --provider_type aws --provider_id 123456789012 --vpc_id vpc-12345678 --subnet_id subnet-12345678

    • get_configuration - Gets the list of tuning options defined for an account

      Example:

      $ alertlogic-cli --account_id 12345678 deployment get_configuration

    • scanner_estimation - Gets the estimation for required number of scanners for a given scope

      Options available:

      --deployment_id DEPLOYMENT_ID - Point at specific deployment

      --vpc_key VPC_KEY - Point at specific vpc

      Example:

      $ alertlogic-cli --account_id 12345678 deployment scanner_estimation --deployment_id 00000000-0000-0000-0000-000000000000 --vpc_key vpc-12345678

    • installation_status - Gets the status of installations deployed in guided mode

      Options available:

      --vpc_key VPC_KEY - Point at specific vpc

      Example:

      $ alertlogic-cli --account_id 12345678 deployment installation_status --vpc_key vpc-12345678

    • redeploy - Redeploys infrastructure within provided scope

      Options available:

      --deployment_id DEPLOYMENT_ID - Point at specific deployment

      --vpc_key VPC_KEY - Point at specific vpc

      Example:

      $ alertlogic-cli --account_id 12345678 deployment redploy --deployment_id 00000000-0000-0000-0000-000000000000 --vpc_key vpc-12345678

For further information run alertlogic-cli --help.