Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: prefer the use of Host Retention Policies #391

Merged
merged 1 commit into from
Dec 4, 2024
Merged

chore: prefer the use of Host Retention Policies #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions bash/install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Ensure the following API scopes are enabled:
> Use this scope when configuring the `FALCON_SENSOR_UPDATE_POLICY_NAME` environment variable.
- (optional) **Hosts** [write]
> Use this scope when configuring the `FALCON_REMOVE_HOST` environment variable for the uninstall script.
>
> :warning:
> It is recommended to use Host Retention Policies in the Falcon console instead.



## Configuration

Expand Down Expand Up @@ -267,6 +272,7 @@ Other Options:
- FALCON_REMOVE_HOST (default: unset)
Determines whether the host should be removed from the Falcon console after uninstalling the sensor.
Requires API Authentication.
NOTE: It is recommended to use Host Retention Policies in the Falcon console instead.
Accepted values are ['true', 'false'].

- GET_ACCESS_TOKEN (default: unset)
Expand Down Expand Up @@ -308,15 +314,6 @@ bash falcon-linux-uninstall.sh
curl -L https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.7.1/bash/install/falcon-linux-uninstall.sh | bash
```

#### Uninstall and remove the host from the Falcon console

```bash
export FALCON_CLIENT_ID="XXXXXXX"
export FALCON_CLIENT_SECRET="YYYYYYYYY"
export FALCON_REMOVE_HOST="true"
curl -L https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.7.1/bash/install/falcon-linux-uninstall.sh | bash
```

## Troubleshooting

To troubleshoot installation issues, run the script by using `bash -x`:
Expand Down
1 change: 1 addition & 0 deletions bash/install/falcon-linux-uninstall.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Other Options:
- FALCON_REMOVE_HOST (default: unset)
Determines whether the host should be removed from the Falcon console after uninstalling the sensor.
Requires API Authentication.
NOTE: It is recommended to use Host Retention Policies in the Falcon console instead.
Accepted values are ['true', 'false'].

- GET_ACCESS_TOKEN (default: unset)
Expand Down
9 changes: 1 addition & 8 deletions powershell/install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Delete sensor uninstaller package when complete [default: $true]
.PARAMETER DeleteScript
Delete script when complete [default: $false]
.PARAMETER RemoveHost
Remove host from CrowdStrike Falcon [requires either FalconClientId|FalconClientSecret or FalconAccessToken]
Remove host from CrowdStrike Falcon [requires either FalconClientId|FalconClientSecret or FalconAccessToken]. It is recommended to use Host Retention Policies to remove hosts from the Falcon console instead of this parameter.
.PARAMETER FalconCloud
CrowdStrike Falcon OAuth2 API Hostname [default: autodiscover]
.PARAMETER FalconClientId
Expand Down Expand Up @@ -184,13 +184,6 @@ Basic example that will uninstall the sensor with the provided maintenance token
.\falcon_windows_uninstall.ps1 -MaintenanceToken <string>
```

An example using the Falcon API to retrieve the maintenance token and remove the host from the Falcon console
after uninstalling.

```pwsh
.\falcon_windows_uninstall.ps1 -FalconClientId <string> -FalconClientSecret <string> -RemoveHost
```

## Troubleshooting

To assist in troubleshooting the installation scripts, you can try the following:
Expand Down
2 changes: 1 addition & 1 deletion powershell/install/falcon_windows_uninstall.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Delete sensor uninstaller package when complete [default: $true]
.PARAMETER DeleteScript
Delete script when complete [default: $false]
.PARAMETER RemoveHost
Remove host from CrowdStrike Falcon [requires either FalconClientId|FalconClientSecret or FalconAccessToken]
Remove host from CrowdStrike Falcon [requires either FalconClientId|FalconClientSecret or FalconAccessToken]. It is recommended to use Host Retention Policies to remove hosts from the Falcon console instead of this parameter.
.PARAMETER FalconCloud
CrowdStrike Falcon OAuth2 API Hostname [default: autodiscover]
.PARAMETER FalconClientId
Expand Down
Loading