Skip to content

Commit

Permalink
docs: Run make generate-docs
Browse files Browse the repository at this point in the history
Signed-off-by: Darren Murray <[email protected]>
  • Loading branch information
dmurray-lacework committed Nov 16, 2021
1 parent cf32b2f commit b6438a1
Show file tree
Hide file tree
Showing 30 changed files with 1,395 additions and 1 deletion.
46 changes: 46 additions & 0 deletions cli/docs/lacework_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## lacework account

manage accounts in an organization (org admins only)

### Synopsis

Manage accounts inside your Lacework organization.

An organization can contain multiple accounts so you can also manage components
such as alerts, resource groups, team members, and audit logs at a more granular
level inside an organization. A team member may have access to multiple accounts
and can easily switch between them.

To enroll your Lacework account in an organization follow the documentation:

https://support.lacework.com/hc/en-us/articles/360041727394-Organization-Overview


### Options

```
-h, --help help for account
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework](lacework.md) - A tool to manage the Lacework cloud security platform.
* [lacework account list](lacework_account_list.md) - list all accounts

39 changes: 39 additions & 0 deletions cli/docs/lacework_account_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## lacework account list

list all accounts

### Synopsis

List all accounts in your organization.

```
lacework account list [flags]
```

### Options

```
-h, --help help for list
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework account](lacework_account.md) - manage accounts in an organization (org admins only)

44 changes: 44 additions & 0 deletions cli/docs/lacework_alert-rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## lacework alert-rule

manage alert rules

### Synopsis

Manage alert rules to route events to the appropriate people or tools.
An alert rule has three parts:
1. Alert channel(s) that should receive the event notification
2. Event severity and categories to include
3. Resource group(s) containing the subset of your environment to consider


### Options

```
-h, --help help for alert-rule
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework](lacework.md) - A tool to manage the Lacework cloud security platform.
* [lacework alert-rule create](lacework_alert-rule_create.md) - create a new alert rule
* [lacework alert-rule delete](lacework_alert-rule_delete.md) - delete a alert rule
* [lacework alert-rule list](lacework_alert-rule_list.md) - list all alert rules
* [lacework alert-rule show](lacework_alert-rule_show.md) - show an alert rule by id

39 changes: 39 additions & 0 deletions cli/docs/lacework_alert-rule_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## lacework alert-rule create

create a new alert rule

### Synopsis

Creates a new single alert rule.

```
lacework alert-rule create [flags]
```

### Options

```
-h, --help help for create
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework alert-rule](lacework_alert-rule.md) - manage alert rules

39 changes: 39 additions & 0 deletions cli/docs/lacework_alert-rule_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## lacework alert-rule delete

delete a alert rule

### Synopsis

Delete a single alert rule by it's ID.

```
lacework alert-rule delete [flags]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework alert-rule](lacework_alert-rule.md) - manage alert rules

39 changes: 39 additions & 0 deletions cli/docs/lacework_alert-rule_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## lacework alert-rule list

list all alert rules

### Synopsis

List all alert rules configured in your Lacework account.

```
lacework alert-rule list [flags]
```

### Options

```
-h, --help help for list
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework alert-rule](lacework_alert-rule.md) - manage alert rules

39 changes: 39 additions & 0 deletions cli/docs/lacework_alert-rule_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## lacework alert-rule show

show an alert rule by id

### Synopsis

Show a single alert rule by it's ID.

```
lacework alert-rule show [flags]
```

### Options

```
-h, --help help for show
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework alert-rule](lacework_alert-rule.md) - manage alert rules

39 changes: 39 additions & 0 deletions cli/docs/lacework_compliance_google_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## lacework compliance google list

list gcp projects and organizations

### Synopsis

List all GCP projects and organization IDs.

```
lacework compliance google list [flags]
```

### Options

```
-h, --help help for list
```

### Options inherited from parent commands

```
-a, --account string account subdomain of URL (i.e. <ACCOUNT>.lacework.net)
-k, --api_key string access key id
-s, --api_secret string secret access key
--api_token string access token (replaces the use of api_key and api_secret)
--debug turn on debug logging
--json switch commands output from human-readable to json format
--nocache turn off caching
--nocolor turn off colors
--noninteractive turn off interactive mode (disable spinners, prompts, etc.)
--organization access organization level data sets (org admins only)
-p, --profile string switch between profiles configured at ~/.lacework.toml
--subaccount string sub-account name inside your organization (org admins only)
```

### SEE ALSO

* [lacework compliance google](lacework_compliance_google.md) - compliance for Google Cloud

Loading

0 comments on commit b6438a1

Please sign in to comment.