Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@PrzemyslawKlys
PrzemyslawKlys committed Oct 25, 2020
1 parent 4778ad0 commit c37458c
Show file tree
Hide file tree
Showing 10 changed files with 365 additions and 165 deletions.
48 changes: 31 additions & 17 deletions Docs/Find-DKIMRecord.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Find-DKIMRecord

## SYNOPSIS
{{ Fill in the Synopsis }}
Queries DNS to provide DKIM information

## SYNTAX

Expand All @@ -18,21 +18,35 @@ Find-DKIMRecord [-DomainName] <Array> [-Selector <String>] [-DnsServer <String>]
```

## DESCRIPTION
{{ Fill in the Description }}
Queries DNS to provide DKIM information

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
### EXAMPLE 1
```
# Standard way
```

Find-DKIMRecord -DomainName 'evotec.pl', 'evotec.xyz' | Format-Table *

{{ Add example description here }}
### EXAMPLE 2
```
# Https way via Cloudflare
```

Find-DKIMRecord -DomainName 'evotec.pl', 'evotec.xyz' -DNSProvider Cloudflare | Format-Table *

### EXAMPLE 3
```
# Https way via Google
```

Find-DKIMRecord -DomainName 'evotec.pl', 'evotec.xyz' -Selector 'selector1' -DNSProvider Google | Format-Table *

## PARAMETERS

### -DomainName
{{ Fill DomainName Description }}
Name/DomainName to query for DKIM record

```yaml
Type: Array
Expand All @@ -47,7 +61,8 @@ Accept wildcard characters: False
```
### -Selector
{{ Fill Selector Description }}
Selector name.
Default: selector1
```yaml
Type: String
Expand All @@ -56,13 +71,14 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: Selector1
Accept pipeline input: False
Accept wildcard characters: False
```
### -DnsServer
{{ Fill DnsServer Description }}
Allows to choose DNS IP address to ask for DNS query.
By default uses system ones.
```yaml
Type: String
Expand Down Expand Up @@ -92,7 +108,7 @@ Accept wildcard characters: False
```
### -AsHashTable
{{ Fill AsHashTable Description }}
Returns Hashtable instead of PSCustomObject
```yaml
Type: SwitchParameter
Expand All @@ -101,13 +117,13 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -AsObject
{{ Fill AsObject Description }}
Returns an object rather than string based represantation for name servers (for easier display purposes)
```yaml
Type: SwitchParameter
Expand All @@ -116,7 +132,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -126,11 +142,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### System.String[]
## OUTPUTS
### System.Object
## NOTES
General notes
## RELATED LINKS
43 changes: 28 additions & 15 deletions Docs/Find-DMARCRecord.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Find-DMARCRecord

## SYNOPSIS
{{ Fill in the Synopsis }}
Queries DNS to provide DMARC information

## SYNTAX

Expand All @@ -18,21 +18,35 @@ Find-DMARCRecord [-DomainName] <Array> [-DnsServer <String>] [-DNSProvider <Stri
```

## DESCRIPTION
{{ Fill in the Description }}
Queries DNS to provide DMARC information

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
### EXAMPLE 1
```
# Standard way
```

Find-DMARCRecord -DomainName 'evotec.pl', 'evotec.xyz' | Format-Table *

### EXAMPLE 2
```
# Https way via Cloudflare
```

Find-DMARCRecord -DomainName 'evotec.pl', 'evotec.xyz' -DNSProvider Cloudflare | Format-Table *

{{ Add example description here }}
### EXAMPLE 3
```
# Https way via Google
```

Find-DMARCRecord -DomainName 'evotec.pl', 'evotec.xyz' -DNSProvider Google | Format-Table *

## PARAMETERS

### -DomainName
{{ Fill DomainName Description }}
Name/DomainName to query for DMARC record

```yaml
Type: Array
Expand All @@ -47,7 +61,8 @@ Accept wildcard characters: False
```
### -DnsServer
{{ Fill DnsServer Description }}
Allows to choose DNS IP address to ask for DNS query.
By default uses system ones.
```yaml
Type: String
Expand Down Expand Up @@ -77,7 +92,7 @@ Accept wildcard characters: False
```
### -AsHashTable
{{ Fill AsHashTable Description }}
Returns Hashtable instead of PSCustomObject
```yaml
Type: SwitchParameter
Expand All @@ -86,13 +101,13 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -AsObject
{{ Fill AsObject Description }}
Returns an object rather than string based represantation for name servers (for easier display purposes)
```yaml
Type: SwitchParameter
Expand All @@ -101,7 +116,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -111,11 +126,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### System.String[]
## OUTPUTS
### System.Object
## NOTES
General notes
## RELATED LINKS
43 changes: 28 additions & 15 deletions Docs/Find-DNSBL.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Find-DNSBL

## SYNOPSIS
{{ Fill in the Synopsis }}
Searches DNSBL if particular IP is blocked on DNSBL.

## SYNTAX

Expand All @@ -28,21 +28,34 @@ Find-DNSBL -IP <String[]> [-BlockListServers <String[]>] [-All] [-DNSProvider <S
```

## DESCRIPTION
{{ Fill in the Description }}
Searches DNSBL if particular IP is blocked on DNSBL.

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
### EXAMPLE 1
```
Find-DNSBL -IP '89.74.48.96' | Format-Table
```

### EXAMPLE 2
```
Find-DNSBL -IP '89.74.48.96', '89.74.48.97', '89.74.48.98' | Format-Table
```

### EXAMPLE 3
```
Find-DNSBL -IP '89.74.48.96' -DNSServer 1.1.1.1 | Format-Table
```

{{ Add example description here }}
### EXAMPLE 4
```
Find-DNSBL -IP '89.74.48.96' -DNSProvider Cloudflare | Format-Table
```

## PARAMETERS

### -IP
{{ Fill IP Description }}
IP to check if it exists on DNSBL

```yaml
Type: String[]
Expand All @@ -57,7 +70,7 @@ Accept wildcard characters: False
```
### -BlockListServers
{{ Fill BlockListServers Description }}
Provide your own blocklist of servers
```yaml
Type: String[]
Expand All @@ -66,13 +79,14 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: $Script:BlockList
Accept pipeline input: False
Accept wildcard characters: False
```
### -All
{{ Fill All Description }}
Return All entries.
By default it returns only those on DNSBL.
```yaml
Type: SwitchParameter
Expand All @@ -81,13 +95,14 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -DNSServer
{{ Fill DNSServer Description }}
Allows to choose DNS IP address to ask for DNS query.
By default uses system ones.
```yaml
Type: String
Expand Down Expand Up @@ -121,11 +136,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
General notes
## RELATED LINKS
Loading

0 comments on commit c37458c

Please sign in to comment.