From 2792005841834375715a2759b2d1eae1dbdec97e Mon Sep 17 00:00:00 2001 From: netikus <84867531+netikus@users.noreply.github.com> Date: Tue, 21 Jun 2022 18:33:37 -0500 Subject: [PATCH] Help updates --- Add-ESVariable.md | 7 +++---- Remove-ESHost.md | 11 +++++------ Set-ESGroupProperty.md | 5 ++--- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/Add-ESVariable.md b/Add-ESVariable.md index cf2d2af..e7c7e2b 100644 --- a/Add-ESVariable.md +++ b/Add-ESVariable.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Add-ESVariable ## SYNOPSIS -{{ Defines a new variable }} +{{ Adds a new variable to EventSentry }} ## SYNTAX @@ -17,12 +17,12 @@ Add-ESVariable [-Name] [-DefaultValue] [] ``` ## DESCRIPTION -{{ Defines a new variable }} +{{ Adds a new variable to EventSentry }} ## EXAMPLES ### Example 1 -```powershell +``` PS C:\> {{ Add-ESVariable EMAILRECIPIENT first.lastname@yourcompany.com }} ``` @@ -66,7 +66,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/Remove-ESHost.md b/Remove-ESHost.md index 8bec02f..46ce43a 100644 --- a/Remove-ESHost.md +++ b/Remove-ESHost.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-ESHost ## SYNOPSIS -{{ Removes a host from a group }} +{{ Removes a host }} ## SYNTAX @@ -17,12 +17,12 @@ Remove-ESHost [-Group] [-Hostname] [] ``` ## DESCRIPTION -{{ Removes a host from a group }} +{{ Removes a host }} ## EXAMPLES ### Example 1 -```powershell +``` PS C:\> {{ Remove-ESHost "Default Group" SERVER17 }} ``` @@ -31,7 +31,7 @@ PS C:\> {{ Remove-ESHost "Default Group" SERVER17 }} ## PARAMETERS ### -Group -{{ Name of the group from which the host should be removed from }} +{{ Name of the group the host is a member of }} ```yaml Type: String @@ -46,7 +46,7 @@ Accept wildcard characters: False ``` ### -Hostname -{{ Host to remove }} +{{ Name of the host to remove }} ```yaml Type: String @@ -66,7 +66,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/Set-ESGroupProperty.md b/Set-ESGroupProperty.md index 8f4cfcc..18a144a 100644 --- a/Set-ESGroupProperty.md +++ b/Set-ESGroupProperty.md @@ -22,7 +22,7 @@ Set-ESGroupProperty [-Group] [-PropertyType] [-PropertyValue] ## EXAMPLES ### Example 1 -```powershell +``` PS C:\> {{ Set-ESGroupProperty "Network Devices" RequiredErrorCount 3 }} ``` @@ -61,7 +61,7 @@ Accept wildcard characters: False ``` ### -PropertyValue -{{ The value of the property to be set, for boolean values use "yes", "no", "true" or "false" }} +{{ The value of the property to be set }} ```yaml Type: String @@ -81,7 +81,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### None - ## OUTPUTS ### System.Object