asbuiltreport / asbuiltreport.core Goto Github PK

Is your feature request related to a problem? Please describe.

It would be good in my opinion that the default logo of the report be the AsBuiltReport project icon.

Describe the solution you'd like

We could add the ability for the user to set the logo of their choice, using the report configuration file (JSON).

Issue by MrZumma
Tue Sep 4 16:36:27 2018
Originally opened as tpcarman/As-Built-Report#16

I have narrowed down the module that is throwing the error below in PS. In vSphere\vSphere.json, when the InfoLevel for VMhost is set to 3 or higher, the below error is thrown in the PowerShell window.

I have also disabled all other InfoLevel options except for VMhost, and the error is still thrown. It is not thrown for any other module.

I have tested all four output methods. Only Word and XML output fail with the error below. The HTML and TEXT options create the report as expected and does not throw the error below.

Screenshot

Desktop

• OS: Windows 10
• PowerShell: 5.1
• PowerCLI: 10.0
• PScribo: 0.7.24
• As-Built-Report: 0.2.0

Describe the bug
If multiple versions of the same report module (eg. AsBuiltReport.VMware.vSphere) are installed, an error may appear when running either of these commands,

• New-AsBuiltReport
• New-AsBuiltConfig
• New-AsBuiltReportConfig

Error Message

Copy-Item : Cannot find path 'C:\Program Files\WindowsPowerShell\Modules\AsBuiltReport.VMware.vSphere\1.0.6 C:\Program
Files\WindowsPowerShell\Modules\AsBuiltReport.VMware.vSphere\1.0.0\AsBuiltReport.VMware.vSphere AsBuiltReport.VMware.vSphere.json' because it does not exist.
At C:\Program Files\WindowsPowerShell\Modules\AsBuiltReport.Core\1.0.0\Src\Public\New-AsBuiltReportConfig.ps1:78 char:17
+ ...             Copy-Item -Path "$($Module.ModuleBase)\$($Module.Name).js ...
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (C:\Program File...re.vSphere.json:String) [Copy-Item], ItemNotFoundException
    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.CopyItemCommand

Workaround 1

1. Uninstall older versions of the report modules
   Uninstall-module -Name AsBuiltReport.<Report.Module> -RequiredVersion <version to uninstall>

Workaround 2
Run New-AsBuiltReport and specify existing configuration files

1. Specify AsBuiltReport config using -AsBuiltConfigPath parameter
2. Specify Report config using -ReportConfigPath parameter

Is your feature request related to a problem? Please describe.

Presently when a report module calls an Office 365 MFA request, many PowerShell modules will pop the MFA window "behind" the currently active window. The Microsoft Teams Module is notorious for this.

For example when calling
New-AsBuiltReport -Report Microsoft.Teams -Target 'ccb889e6-xxxx-xxxx-xxxx-d8efb6094a75' -MFA -Format Html,Word -OutputFolderPath 'C:\UcMadScientist\AsBuiltReport.Microsoft.Teams\reports' -Timestamp

Abr.Core will call the module and that module will attempt to connect to an Office365 service. Meanwhile, ABR.Core is displaying the message "Please wait while the Microsoft Teams As Built Report is being generated."

However, PowerShell has opened a new window prompting the user to log on, but it's behind the current window.

(Note the new PowerShell window indicated by the Green Arrow. This window is hiding behind VsCode)

(Same thing with PowerShell inside Windows Terminal)

This isn't an issue with ABR as it is, but something we could address in ABR.Core

Describe the solution you'd like
I guess my question is, this is simple enough for me to handle in my module (Microsoft.Teams), but I feel this is something that will affect multiple Office365 services. Should we consider adding a prompt to Abr.Core for users to check for an MFA window if $MFA is $True?

Happy to submit a PR for this.

Describe alternatives you've considered
I can easily add a Write-Host prompt to my module to prompt users to check for the window.

Is your feature request related to a problem? Please describe.

It would be ideal to add an option to export the "Sample Report.html" as long as it is available in the Sample folder of the project.

Describe the solution you'd like

• Example Command
  • New-AsBuiltReport -Report VMware.SRM -OutputFolderPath /home/rebelinux/script -SampleReport

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Description

It would be nice to add some protection against running the report from a Powershell ISE window.

    if ($psISE) {
        Write-Error -Message "You cannot run this script inside the PowerShell ISE. Please execute it from the PowerShell Command Window."
        break
    }

rebelinux@d61484d

Additional Context

No response

Before submitting

• I have read the documentation, and referred to the known issues before submitting this change request.
• I have checked for previously opened & closed issues before submitting this change request.

In some environments username/password is not allowed. Passthru authentication support would be nice. Not requiring username/password would be helpful.

Hello,

it is possible to allow paramters -Folderpath and -Filename for New-AsBuiltConfig?

We can specify this on New-AsBuiltReportConfig and it is very helpful if you want to fully automate the report generation. The New-AsBuiltConfig don't allow to specify this parameters and the outcome depends on the input choices made by the enduser.
This is an problem, if you want to use the generated configuration to generate the reports fully automated.

Best regards,
Jens

Is your feature request related to a problem? Please describe.
When running New-AsBuiltReport with no paramters specified, an error is shown because Powershell is not sure which parameter set to use:
New-AsBuiltReport : Parameter set cannot be resolved using the specified named parameters.

Describe the solution you'd like
Implement a default parameter set so the user is prompted for mandatory paramters if running New-AsBuiltReport without any parameters

Describe alternatives you've considered
Leaving the functionality as-is which means the user will receive an error if they try to run the cmdlet without any parameters as described above. This would be OK as the error message shown is relevant, but it might confuse powershell novice users.

Is your feature request related to a problem? Please describe.

It would be beneficial to add the option to generate the report in an available language. I don't know if it is achievable but maybe there could be a JSON file with the translations depending on the language. With the option for the user to create the JSON with the language of his choice based on a default english template

Describe the solution you'd like

• Command Example

  • New-AsBuiltReport -Report VMware.SRM -Target 192.168.5.2 -Format Word -Credential $cred (-Language French)

• Section Example

  • Section -Style Heading1 "$(Protection Groups JSON Variable)" {}

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Describe the bug
When running New-AsBuiltReport, if the path specified for -OutputPath does not exist, there is no check for this and the document will fail to be saved after the report function has completed.

To Reproduce
Steps to reproduce the behavior:

1. Run New-AsBuiltReport and specify a folder for -OutputPath that does not exist

Expected behavior
The function should check for the existance of the folder specified as the OutputPath and if it does not exist, error and break before running the report function.

Screenshots
If applicable, add screenshots to help explain your problem.

System (please provide the following information about the system from which you are trying to generate a report):

• OS: Windows 1-
• Windows PowerShell version: 5.1
• Vendor PowerShell Module name and version: Not relevant
• AsBuiltReport.Core module version: 1.0.0
• AsBuiltReport module name and version: Not relevant

Issue by iron-2
Wed Oct 31 15:02:30 2018
Originally opened as tpcarman/As-Built-Report#50

I appoligize if this already was addressed and I missed it going through the reports.
Describe the bug
In the section "Virtual Port Group NIC Teaming" the UnusedNic is missing in txt document but is there in word document.See screen shots below. In this case Vswitch 2 have Unused Nic's.

To Reproduce
Run a Word and txt report
Expected behavior
Same info in both documents.

Describe the solution you'd like
Add ability to set a default custom style in the AsBuiltReport configuration so that a report will always generate in set style without the use of the StylePath parameter

Is your feature request related to a problem? Please describe.
Currently the AsBuiltReport.Core module only supports authenticating to targets through the use of credentials or Username/Password combinations. More and more applications and vendors are now implementing and supporting MFA to beef up security around their products. This removes the ability to programitically connect via Username/Password or Credentials.

Describe the solution you'd like
By implimenting the ability to authenticate with an API token, reports will still be able to be generated automatically.

Describe alternatives you've considered
Considered modifying individual report modules to look for a username of APIToken, with the token in the password parameter, however that just feels messy and proper support should be created.

Is your feature request related to a problem? Please describe.
Currently passing the -Verbose switch to New-AsBuiltReport does nothing. Whether -Verbose is passed or not, the PScribo cmdlets are run with -Verbose on.

Describe the solution you'd like
I would like to be able to generate a report using the -Verbose switch.
IE
New-AsBuiltReport -Verbose will output verbose statements
New-AsBuiltReport will not output any verbose statements

Adding support for the verbose switch will also allow end-users to turn on/off verbosity when running vendor reports as well.

Describe alternatives you've considered
Hard coding the $VerbosePreference at the beginning of the report and then switching back at the end.

I like to run the reporst generation using a service account (gMSA).
Can this option be considered?
Thanks