Skip to content

Commit 2422ab7

Browse files
authored
Update README.md
1 parent 78414a8 commit 2422ab7

File tree

1 file changed

+40
-26
lines changed

1 file changed

+40
-26
lines changed

README.md

+40-26
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ We recommend to use WMF 5.1.
1919
* Adjust your execution policy to at least remoteSigned (the scripts are not digitally signed yet)
2020

2121
```powershell
22-
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
22+
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
2323
```
2424

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

3434
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*.
3535
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.
36-
* 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.
36+
* 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.
3737
* 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.
3838

39-
### Settings.psd1 ###
40-
In order to use some functions for the report adjust some settings in the file *Settings.psd1* which is located inside the MbamExtensionModule folder
39+
### Settings ###
40+
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:
4141

42-
* To use the email reporting function first add your email settings
42+
* MBAM Server version
43+
```powershell
44+
...
45+
Mbam = @{
46+
Server = @{
47+
Version = "2.5.1135.0"
48+
...
49+
```
4350

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

5866
```powershell
59-
# Expiration date warning starts <CertificateExpiresWarning> days before expiration
60-
CertificateExpiresWarning = 60
61-
62-
# Mbam certificate thumbprint
63-
CertificateThumbprint = "‎fb23b9bedc426ebd7d76c11a6170d7adbebbf"
67+
Settings = @{
68+
Mbam = @{
69+
Server = @{
70+
# Mbam certificate thumbprint
71+
CertificateThumbprint = "fb2493b5bedc426ebd7d76c939a6170d7adbebbf"
72+
...
6473
```
65-
* 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.
66-
6774

75+
* Set the MBAM service account name as well as the used MBAM security groups
76+
```powershell
77+
...
78+
Mbam = @{
79+
Server = @{
80+
# Mbam Service Account (WebService Application Pool Account
81+
ServiceAccount = "MBAMSvcAcc"
82+
# MBAM Advanced Help Desk Security Group (without domain)
83+
AdvHelpDesk = "MBAMAdvHelpDesk"
84+
# MBAM Help Desk Security Group (without domain)
85+
HelpDesk = "MBAMHelpDesk"
86+
# MBAM Reports only Security Group (without domain)
87+
ReportGroup = "MBAMReport"
88+
...
89+
```
6890

91+
* 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.
6992

7093
## Usage ##
7194

72-
### HTML reports ###
73-
You will find two scripts within the package which will give you the possibility to create HTML server reports.
74-
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.
75-
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.
76-
77-
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.
95+
### HTML server reports ###
96+
To create a server html report, run the script *Get-CompleteServerStatus.ps1* within an elevated PowerShell console.
97+
Please remember to adjust your settings inside the *settings.psd1* file as describe above first.
7898

79-
```powershell
80-
$mbamVersion = "2.5.1135.0"
81-
```
82-
83-
```powershell
84-
$reportHtmlTitle = "FB Pro GmbH - MBAM-Server report " + (Get-Date -UFormat "%Y%m%d_%H%M")
85-
```
99+
### HTML client reports ###
100+
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.
86101

87-
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.
88102

89103
### Build your own ###
90104

0 commit comments

Comments
 (0)