Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
devesly authored Sep 3, 2018
1 parent 78414a8 commit 2422ab7
Showing 1 changed file with 40 additions and 26 deletions.
66 changes: 40 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ We recommend to use WMF 5.1.
* Adjust your execution policy to at least remoteSigned (the scripts are not digitally signed yet)

```powershell
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
```

* Copy/put the following folders in a PowerShell default load path to get the modules and classes automatically loaded.
Expand All @@ -33,14 +33,22 @@ We recommend to use WMF 5.1.

A default load path could be e.g. the path in your user profile under *"userprofile"\Documents\WindowsPowerShell\Modules* (if it does not exists, you have to create it) or the new location under *C:\Program Files\WindowsPowerShell\Modules*.
For a easy start you can use the **Install-MbamExtensionModule.ps1** script to add the current of your cloned/unzipped package location into the PowerShell module path environment variable.
* For the server side report run the PowerShell scripts *New-GroupMembersFiles.ps1* and *New-LocalAdminsFile.ps1* inside the folder MbamExtensionModule once to create files which will contain the users of the MBAM security groups as well as a file with all local admins.
* For the server side report run the PowerShell scripts *New-GroupMembersFiles.ps1* and *New-LocalAdminsFile.ps1* inside the folder MbamExtensionModule once to create files which contain the users of the MBAM security groups as well as a file with all local admins.
* To use the new feature of event logging, a new application log must be registered as well as some event sources. For this execute the script *New-FBProEventLogs.ps1* inside the *scripts* folder, it will do the work.

### Settings.psd1 ###
In order to use some functions for the report adjust some settings in the file *Settings.psd1* which is located inside the MbamExtensionModule folder
### Settings ###
Inside the new Settings folder you find the file *Settings.psd1*. This file contains some settings for the creation of the report as well as some set points like the MBAM server version. See explanations below:

* To use the email reporting function first add your email settings
* MBAM Server version
```powershell
...
Mbam = @{
Server = @{
Version = "2.5.1135.0"
...
```

* To use the email reporting function first add your email settings
```powershell
Email = @{
SMTPServer = "smtp.example.com"
Expand All @@ -56,35 +64,41 @@ Email = @{
* For testing the certificate which is used by MBAM add your certificate thumbprint

```powershell
# Expiration date warning starts <CertificateExpiresWarning> days before expiration
CertificateExpiresWarning = 60
# Mbam certificate thumbprint
CertificateThumbprint = "‎fb23b9bedc426ebd7d76c11a6170d7adbebbf"
Settings = @{
Mbam = @{
Server = @{
# Mbam certificate thumbprint
CertificateThumbprint = "fb2493b5bedc426ebd7d76c939a6170d7adbebbf"
...
```
* Its possibile to add a logo to your report. You can change the Base64 string for the variable *logo* or exchange it to an URI. We recommend to use a Base64 string.


* Set the MBAM service account name as well as the used MBAM security groups
```powershell
...
Mbam = @{
Server = @{
# Mbam Service Account (WebService Application Pool Account
ServiceAccount = "MBAMSvcAcc"
# MBAM Advanced Help Desk Security Group (without domain)
AdvHelpDesk = "MBAMAdvHelpDesk"
# MBAM Help Desk Security Group (without domain)
HelpDesk = "MBAMHelpDesk"
# MBAM Reports only Security Group (without domain)
ReportGroup = "MBAMReport"
...
```

* Its possibile to add a logo to your report. You can change the Base64 string for the variable *logo* or exchange it to an URI. We recommend to use a Base64 string.

## Usage ##

### HTML reports ###
You will find two scripts within the package which will give you the possibility to create HTML server reports.
The script *Get-CompleteServerStatus.ps1* creates a report with a bunch of testresults and additional update or login history views. Depending on the size of your MBAM environment, this test could take some time.
That is why the package also includes another script called *Get-QuickServerStatus.ps1* which will not create the history views to get a report faster for occasionally manual testing, e.g. after a MBAM update.

Before running the scripts open them and look at the section *Configuration* after the license block. In order to work properly you may have to adjust some variables like the MBAM version your server is running or the path where the reports will be created.
### HTML server reports ###
To create a server html report, run the script *Get-CompleteServerStatus.ps1* within an elevated PowerShell console.
Please remember to adjust your settings inside the *settings.psd1* file as describe above first.

```powershell
$mbamVersion = "2.5.1135.0"
```

```powershell
$reportHtmlTitle = "FB Pro GmbH - MBAM-Server report " + (Get-Date -UFormat "%Y%m%d_%H%M")
```
### HTML client reports ###
Before running the client script *Get-CompleteClientStatus.ps1* open the script and look at the section *Configuration* after the license block. In order to work properly you may have to adjust some variables like the MBAM version your client agent is running or the path where the reports will be created.

The same applies for the script *Get-CompleteClientStatus.ps1* for creating a HTML-report on a client. Set your MBAM Client Agent version, adjust the save path for your reports and you are ready to go. Remember you have to do the same as you did for the server reports, which means copy the package to the client, install the module and set your execution policy.

### Build your own ###

Expand Down

0 comments on commit 2422ab7

Please sign in to comment.