Skip to content

Commit

Permalink
Merge pull request #731 from maester365/create-pull-request/patch
Browse files Browse the repository at this point in the history
Update maester.dev powershell docs
  • Loading branch information
merill authored Mar 6, 2025
2 parents 3cf0744 + fb52e7d commit 7ee2cdc
Show file tree
Hide file tree
Showing 12 changed files with 375 additions and 16 deletions.
2 changes: 1 addition & 1 deletion website/docs/commands/Get-MailAuthenticationRecord.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Aliases:

Required: False
Position: 2
Default value: 1.1.1.1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
2 changes: 1 addition & 1 deletion website/docs/commands/Resolve-SPFRecord.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Aliases:

Required: False
Position: 3
Default value: 1.1.1.1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
Expand Down
67 changes: 67 additions & 0 deletions website/docs/commands/Test-MtCisAttachmentFilterComprehensive.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
sidebar_class_name: hidden
description: Checks if the common attachment types filter is comprehensive
id: Test-MtCisAttachmentFilterComprehensive
title: Test-MtCisAttachmentFilterComprehensive
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisAttachmentFilterComprehensive.ps1
---

## SYNOPSIS

Checks if the common attachment types filter is comprehensive

## SYNTAX

```powershell
Test-MtCisAttachmentFilterComprehensive [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

The common attachment types filter should be comprehensive

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisAttachmentFilterComprehensive
```

Returns true if the attachment types match the comprehensive list supplied by CIS

## PARAMETERS

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCisAttachmentFilterComprehensive](https://maester.dev/docs/commands/Test-MtCisAttachmentFilterComprehensive)
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
---
sidebar_class_name: hidden
description: Safety Tips are enabled
id: Test-ORCA143
title: Test-ORCA143
description: Checks if audit log search is enabled
id: Test-MtCisAuditLogSearch
title: Test-MtCisAuditLogSearch
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-ORCA143.ps1
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisAuditLogSearch.ps1
---

## SYNOPSIS

Safety Tips are enabled
Checks if audit log search is enabled

## SYNTAX

```powershell
Test-ORCA143 [-ProgressAction <ActionPreference>] [<CommonParameters>]
Test-MtCisAuditLogSearch [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

Generated on 01/19/2025 07:06:36 by .\build\orca\Update-OrcaTests.ps1
Microsoft 365 audit log search should be enabled
CIS Microsoft 365 Foundations Benchmark v4.0.0

## EXAMPLES

### EXAMPLE 1

```powershell
Test-ORCA143
Test-MtCisAuditLogSearch
```

Returns true or false
Returns true if audit log search is enabled

## PARAMETERS

Expand Down Expand Up @@ -64,4 +65,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## RELATED LINKS
[https://maester.dev/docs/commands/Test-ORCA143](https://maester.dev/docs/commands/Test-ORCA143)
[https://maester.dev/docs/commands/Test-MtCisAuditLogSearch](https://maester.dev/docs/commands/Test-MtCisAuditLogSearch)
83 changes: 83 additions & 0 deletions website/docs/commands/Test-MtCisDkim.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
sidebar_class_name: hidden
description: Checks state of DKIM for all EXO domains
id: Test-MtCisDkim
title: Test-MtCisDkim
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisDkim.ps1
---

## SYNOPSIS

Checks state of DKIM for all EXO domains

## SYNTAX

```powershell
Test-MtCisDkim [[-Selector] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

DKIM SHOULD be enabled for all domains.

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisDkim
```

Returns true if DKIM record exists and EXO shows DKIM enabled

## PARAMETERS

### -Selector

Selector-name for the DKIM record to test..

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Selector1
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
\{\{ Fill ProgressAction Description \}\}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCisDkim](https://maester.dev/docs/commands/Test-MtCisDkim)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Notifications for internal users sending malware should be enabled, and an admin
Test-MtCisInternalMalwareNotification
```

Returns true safe malware notifcications are enabled, and an administrator email address is set
Returns true safe malware notifications are enabled, and an administrator email address is set

## PARAMETERS

Expand Down
68 changes: 68 additions & 0 deletions website/docs/commands/Test-MtCisZAP.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
sidebar_class_name: hidden
description: Checks if the Zero-hour auto purge (ZAP) for Microsoft Teams is enabled
id: Test-MtCisZAP
title: Test-MtCisZAP
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtCisZAP.ps1
---

## SYNOPSIS

Checks if the Zero-hour auto purge (ZAP) for Microsoft Teams is enabled

## SYNTAX

```powershell
Test-MtCisZAP [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

Zero-hour auto purge (ZAP) should be enabled for Microsoft Teams
CIS Microsoft 365 Foundations Benchmark v3.1.0

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtCisZAP
```

Returns true if Zero-hour auto purge (ZAP) is enabled

## PARAMETERS

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtCisZAP](https://maester.dev/docs/commands/Test-MtCisZAP)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Alternatively chosen filtering solutions SHOULD offer services comparable to Mic
Test-MtCisaEmailFilterAlternative
```

Allways returns null
Always returns null

## PARAMETERS

Expand Down
3 changes: 2 additions & 1 deletion website/docs/commands/Test-MtCisaPasswordExpiration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ User passwords SHALL NOT expire.
Test-MtCisaPasswordExpiration
```

Returns true if at least 1 domain has password expiration of 100 years or greater
Returns true if all verified managed domains have password expiration configured
to be of 100 years or greater

## PARAMETERS

Expand Down
67 changes: 67 additions & 0 deletions website/docs/commands/Test-MtDeviceComplianceSettings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
sidebar_class_name: hidden
description: Ensure the built-in Device Compliance Policy marks devices with no compliance policy assigned as 'Not compliant'
id: Test-MtDeviceComplianceSettings
title: Test-MtDeviceComplianceSettings
hide_title: false
hide_table_of_contents: false
custom_edit_url: https://github.com/maester365/maester/blob/main/powershell/public/Test-MtDeviceComplianceSettings.ps1
---

## SYNOPSIS

Ensure the built-in Device Compliance Policy marks devices with no compliance policy assigned as 'Not compliant'

## SYNTAX

```powershell
Test-MtDeviceComplianceSettings [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION

The built-in Device Compliance Policy should mark devices with no compliance policy assigned as 'Not compliant'

## EXAMPLES

### EXAMPLE 1

```powershell
Test-MtDeviceComplianceSettings
```

Returns true if the device compliance settings are configured

## PARAMETERS

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
### System.Boolean
## NOTES
## RELATED LINKS
[https://maester.dev/docs/commands/Test-MtDeviceComplianceSettings](https://maester.dev/docs/commands/Test-MtDeviceComplianceSettings)
Loading

0 comments on commit 7ee2cdc

Please sign in to comment.