Skip to content

Script Parameters and Sample Usage

Jump to bottom
Paul Wetter edited this page May 8, 2018 · 1 revision

Below is a list of all the Parameters that can be used with the script:

  • Title

    • The title you would like to use for this documentation. default is "Configuration Manager Site Documentation".

  • FilePath

    • This is the path of the documentation file. By default, the file will be created in the same directory as the where the script is currently located. And named CMDocumentation.html

  • AddDateTime

    • Adds a date time stamp to the end of the file name.
    • Time stamp is in the format of yyyy-MM-dd_HHmm.
    • June 1, 2014 at 6PM is 2014-06-01_1800.
    • Output filename will be ReportName_2014-06-01_1800.html.

  • CompanyName

    • This is the name of the company or organization that the documentation will be created for.

  • CompanyLogo

    • This is a UNC or URL path to a image file jpg, or png to embed into the document on the title page. By default, the Cyber Advisors logo will display.

  • Author

    • This is the report author. Their name appears in the lower right corner of the title page. The default is me, Paul Wetter.

  • Vendor

    • This displays a company name in the lower right corner of the title page. The Default here is Cyber Advisors.

  • Software

    • Specifies whether the script should run an inventory of Applications, Packages and OSD related objects.

  • ListAllInformation

    • Specifies whether the script should only output an overview of what is configured (like count of collections) or a full output with verbose information. This includes: User & Device collections, Application, Packages, ADR Deployments, Drivers in Driver packages, Task Squence Details

  • ListAppDetails

    • Like ListAllInformation, but instead of all details, lists only Application Details.

  • NoSqlDetail

    • Skip additional details from the SQL server. Useful when you do not have full database access to the SQL server (Normally requires access via SQL to the Master and CM database).

  • SMSProvider

    • Some information rely on WMI queries that need to be executed against the SMS Provider directly.
    • Please specify as FQDN.
    • If not specified, it assumes localhost.

  • UnknownClientSettings

    • With new releases of CM come new client settings. If this parameter is added, it will display raw information for these client settings.

  • MaskAccounts

    • This will mask about half of the account name in the documentation

Script Usage Examples

EXAMPLE 1

This will document everything with just the summary information of each component:
DocumentCMCB.ps1

EXAMPLE 2

This will document everything with detailed information. Will make a very large file!
DocumentCMCB.ps1 -ListAllInformation

EXAMPLE 3

This will document everything with detailed information. It will also embed a custom logo from the provided URL into the cover page.
DocumentCMCB.ps1 -CompanyLogo 'http://www.contoso.com/logo.jpg' -ListAllInformation

EXAMPLE 4

This will document everything with summary information, a custom logo, and a custom Author and Vendor.
DocumentCMCB.ps1 -CompanyLogo 'http://www.contoso.com/logo.jpg' -Author "Bugs Bunny" -Vendor "Acme"

Clone this wiki locally