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.

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

EOP-155 ec_mta_sts_purge utility #764

Merged
merged 4 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion content/momentum/4/4-exe.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ This table lists all executable commands alphabetically giving a brief descripti
| [ec_lic](/momentum/4/executable/ec-lic) – Fetch a new license file from Message Systems | misc |
| [ec_log_trace](/momentum/4/executable/ec-log-trace) – Parse Momentum log files | logs |
| [ec_md5passwd](/momentum/4/executable/ec-md-5-passwd) – Change the password for a system user's password | security |
| [ec_rotate](/momentum/4/executable/ec-rotate) – Rotate Momentum logfiles | logs |
| [ec_mta_sts_purge](/momentum/4/executable/ec-mta-sts-purge) - remove expired MTA-STS policy files | misc |
| [ec_rotate](/momentum/4/executable/ec-rotate) – Rotate Momentum logfiles | misc |
| [ec_sendmail](/momentum/4/executable/ec-sendmail) – A sendmail compatibility interface | misc |
| [ec_show](/momentum/4/executable/ec-show) – Show spool or message information | messages |
| [eccfg](/momentum/4/executable/eccfg) – Subversion repository management | config |
Expand Down
56 changes: 56 additions & 0 deletions content/momentum/4/executable/ec-mta-sts-purge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
lastUpdated: "06/30/2024"
title: "ec_mta_sts_purge"
description: "ec mta_sts_purge Remove expired MTA-STS policies from the file system"
---

<a name="executable.ec_mta_sts_purge"></a>
## Name

ec_mta_sts_purge — Remove expired MTA-STS policies from the file system.

## Synopsis

`/opt/msys/ecelerity/bin/ec_mta_sts_purge` [ -dir *`directory`* ]

`/opt/msys/ecelerity/bin/ec_mta_sts_purge` [ -dryrun ]

`/opt/msys/ecelerity/bin/ec_mta_sts_purge` [ -v | -verbose ]

## Description

The **ec_mta_sts_purge** command is a utility script used to remove expired MTA-STS policies from the file system.

Momentum caches MTA-STS policies on the file system. This is to reduce how often Momentum needs to fetch the policies using HTTPS. This also prevents a large number of fetches on a restart. These policies will normally get updated regularly, but if some domains have not been used for a long time, this command can be used to delete the expired policy files for these domains from the file system.

dkoerichbird marked this conversation as resolved.
Show resolved Hide resolved
### Note

The **ec_mta_sts_purge** script will delete files in the default location. If you have specified a different location via `mta_sts_policy_store`, the `-dir` option must be used.

The following options change the behavior of the **ec_mta_sts_purge** command:

<dl class="variablelist">

<dt>-dir directory</dt>

<dd>

Specify the full path to the directory where the policy files are stored. Default is `/var/spool/ecelerity/mtasts`.

</dd>

<dt>-dryrun</dt>

<dd>

If this option is specified, the script will just list the files that would be deleted.

</dd>

</dl>

The following is an example:

```sh
/opt/msys/ecelerity/bin/ec_mta_sts_purge -dryrun -dir /path/to/policy/files
dkoerichbird marked this conversation as resolved.
Show resolved Hide resolved
```
1 change: 1 addition & 0 deletions content/momentum/4/executable/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ description: "Table of Contents ad summary summarize the adaptive module actions
| [ec_lic](/momentum/4/executable/ec-lic) | fetch a new license file from Message Systems |
| [ec_log_trace](/momentum/4/executable/ec-log-trace) | parse Momentum log files |
| [ec_md5passwd](/momentum/4/executable/ec-md-5-passwd) | changes the password for a system user's password |
| [ec_mta_sts_purge](/momentum/4/executable/ec-mta-sts-purge) | remove expired MTA-STS policy files |
| [ec_rotate](/momentum/4/executable/ec-rotate) | rotate Momentum logfiles |
| [ec_sendmail](/momentum/4/executable/ec-sendmail) | a sendmail compatibility interface |
| [ec_show](/momentum/4/executable/ec-show) | show spool or message information |
Expand Down
Loading