From eded13d55eaf7b358f01a8c37255298a912f21bc Mon Sep 17 00:00:00 2001 From: Kris Kelley Date: Fri, 14 Jun 2024 09:51:00 -0400 Subject: [PATCH 1/4] EOP-155 ec_mta_sts_purge utility --- content/momentum/4/4-exe.md | 3 +- .../momentum/4/executable/ec-mta-sts-purge.md | 56 +++++++++++++++++++ content/momentum/4/executable/index.md | 1 + 3 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 content/momentum/4/executable/ec-mta-sts-purge.md diff --git a/content/momentum/4/4-exe.md b/content/momentum/4/4-exe.md index ae4798dec..0762ddde2 100644 --- a/content/momentum/4/4-exe.md +++ b/content/momentum/4/4-exe.md @@ -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 | +| [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 | diff --git a/content/momentum/4/executable/ec-mta-sts-purge.md b/content/momentum/4/executable/ec-mta-sts-purge.md new file mode 100644 index 000000000..167fc1c2c --- /dev/null +++ b/content/momentum/4/executable/ec-mta-sts-purge.md @@ -0,0 +1,56 @@ +--- +lastUpdated: "03/26/2020" +title: "ec_mta_sts_purge" +description: "ec mta_sts_purge Remove expired MTA-STS policies from the file system" +--- + + +## 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 HTTP. This also prevents a large number of fetches on a restart. These policies will normally get updated regularly, but if a domain is not used for a long time, this command can be used to delete the expired policy file for this domain from the file system. + +### Note + +The **ec_mta_sts_purge** script will by default 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 behavor of the **ec_mta_sts_purge** command: + +
+ +
-dir *`directory`*
+ +
+ +Specify the full path to the directory where the policy files are stored. Default is '/var/spool/ecelerity/mtasts'. + +
+ +
-dryrun
+ +
+ +If this option is specified, the script will just print files that would be deleted. + +
+ +
+ +The following is an example: + +``` +/opt/msys/ecelerity/bin/ec_mta_sts_purge -dryrun -dir /path/to/policy/files +``` diff --git a/content/momentum/4/executable/index.md b/content/momentum/4/executable/index.md index 0f5f944b9..490c9186b 100644 --- a/content/momentum/4/executable/index.md +++ b/content/momentum/4/executable/index.md @@ -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.md) | 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 | From 6ed7d5ce2be476b50d69604624b870abd0977e04 Mon Sep 17 00:00:00 2001 From: Kris Kelley Date: Fri, 14 Jun 2024 10:15:37 -0400 Subject: [PATCH 2/4] tweaks --- content/momentum/4/4-exe.md | 2 +- content/momentum/4/executable/ec-mta-sts-purge.md | 10 +++++----- content/momentum/4/executable/index.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/content/momentum/4/4-exe.md b/content/momentum/4/4-exe.md index 0762ddde2..172e6d434 100644 --- a/content/momentum/4/4-exe.md +++ b/content/momentum/4/4-exe.md @@ -22,7 +22,7 @@ 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_mta_sts_purge](/momentum/4/executable/ec-mta-sts-purge) - remove expired MTA-STS policy files | +| [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 | diff --git a/content/momentum/4/executable/ec-mta-sts-purge.md b/content/momentum/4/executable/ec-mta-sts-purge.md index 167fc1c2c..c3e40b7f6 100644 --- a/content/momentum/4/executable/ec-mta-sts-purge.md +++ b/content/momentum/4/executable/ec-mta-sts-purge.md @@ -21,11 +21,11 @@ ec_mta_sts_purge — Remove expired MTA-STS policies from the file system 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 HTTP. This also prevents a large number of fetches on a restart. These policies will normally get updated regularly, but if a domain is not used for a long time, this command can be used to delete the expired policy file for this domain 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 HTTP. 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. ### Note -The **ec_mta_sts_purge** script will by default 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 **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 behavor of the **ec_mta_sts_purge** command: @@ -35,7 +35,7 @@ The following options change the behavor of the **ec_mta_sts_purge** command:
-Specify the full path to the directory where the policy files are stored. Default is '/var/spool/ecelerity/mtasts'. +Specify the full path to the directory where the policy files are stored. Default is `/var/spool/ecelerity/mtasts`.
@@ -43,7 +43,7 @@ Specify the full path to the directory where the policy files are stored. Defaul
-If this option is specified, the script will just print files that would be deleted. +If this option is specified, the script will just list the files that would be deleted.
@@ -51,6 +51,6 @@ If this option is specified, the script will just print files that would be dele The following is an example: -``` +```sh /opt/msys/ecelerity/bin/ec_mta_sts_purge -dryrun -dir /path/to/policy/files ``` diff --git a/content/momentum/4/executable/index.md b/content/momentum/4/executable/index.md index 490c9186b..701ad620c 100644 --- a/content/momentum/4/executable/index.md +++ b/content/momentum/4/executable/index.md @@ -20,7 +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.md) | remove expired MTA-STS policy files | +| [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 | From fd27016309fed50f6618da076e97e735b0e61b26 Mon Sep 17 00:00:00 2001 From: Kris Kelley Date: Tue, 18 Jun 2024 10:00:21 -0400 Subject: [PATCH 3/4] tweaks as per review --- content/momentum/4/executable/ec-mta-sts-purge.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/momentum/4/executable/ec-mta-sts-purge.md b/content/momentum/4/executable/ec-mta-sts-purge.md index c3e40b7f6..2ce660b1a 100644 --- a/content/momentum/4/executable/ec-mta-sts-purge.md +++ b/content/momentum/4/executable/ec-mta-sts-purge.md @@ -21,7 +21,7 @@ ec_mta_sts_purge — Remove expired MTA-STS policies from the file system 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 HTTP. 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. +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. ### Note @@ -31,7 +31,7 @@ The following options change the behavor of the **ec_mta_sts_purge** command:
-
-dir *`directory`*
+
-dir directory
From edaee8aa1b750072962fc5ba2ff29ef7834e1c97 Mon Sep 17 00:00:00 2001 From: Doug Koerich Date: Tue, 9 Jul 2024 16:12:52 -0300 Subject: [PATCH 4/4] EOP-155: Minor changes Signed-off-by: Doug Koerich --- content/momentum/4/executable/ec-mta-sts-purge.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/momentum/4/executable/ec-mta-sts-purge.md b/content/momentum/4/executable/ec-mta-sts-purge.md index 2ce660b1a..f0b64b187 100644 --- a/content/momentum/4/executable/ec-mta-sts-purge.md +++ b/content/momentum/4/executable/ec-mta-sts-purge.md @@ -1,5 +1,5 @@ --- -lastUpdated: "03/26/2020" +lastUpdated: "06/30/2024" title: "ec_mta_sts_purge" description: "ec mta_sts_purge Remove expired MTA-STS policies from the file system" --- @@ -7,7 +7,7 @@ description: "ec mta_sts_purge Remove expired MTA-STS policies from the file sys ## Name -ec_mta_sts_purge — Remove expired MTA-STS policies from the file system +ec_mta_sts_purge — Remove expired MTA-STS policies from the file system. ## Synopsis @@ -21,13 +21,13 @@ ec_mta_sts_purge — Remove expired MTA-STS policies from the file system 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. +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. ### 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 behavor of the **ec_mta_sts_purge** command: +The following options change the behavior of the **ec_mta_sts_purge** command: