├── docs ├── license.md ├── release-notes.md ├── snippets │ ├── pre-req-linux.sh │ ├── vars-linux.ps1 │ ├── vars-windows.ps1 │ ├── vars-domain.ps1 │ ├── update-module.ps1 │ ├── installed-module.ps1 │ ├── vars-health.ps1 │ ├── copy-module-local-linux.sh │ ├── vars-vcf.ps1 │ ├── copy-module-local-windows.ps1 │ ├── update-modules.ps1 │ ├── import-module.ps1 │ ├── import-module-local-linux.ps1 │ ├── save-module-local-windows.ps1 │ ├── save-module-local-linux.ps1 │ └── install-module.ps1 ├── community │ ├── contributing.md │ ├── code-of-conduct.md │ ├── index.md │ └── support.md ├── assets │ ├── stylesheets │ │ └── extra.css │ └── images │ │ ├── icon-color.svg │ │ └── icon-white.svg ├── favicon.ico ├── requirements.txt ├── user-access.md ├── update.md └── documentation │ ├── getting-started │ ├── upgrade-precheck-report.md │ ├── overview-report.md │ └── configuration-report.md │ └── functions │ ├── Test-VcfReportingPrereq.md │ ├── Request-HardwareOverview.md │ ├── Request-ValidatedSolutionOverview.md │ ├── Publish-DnsHealth.md │ ├── Publish-NtpHealth.md │ ├── Publish-EsxiHealth.md │ ├── Publish-NsxtHealth.md │ ├── Publish-VsanHealth.md │ ├── Publish-ServiceHealth.md │ ├── Publish-VcenterHealth.md │ ├── Publish-VersionHealth.md │ ├── Publish-PasswordHealth.md │ ├── Publish-ConnectivityHealth.md │ ├── Publish-CertificateHealth.md │ ├── Publish-NsxtEdgeNodeHealth.md │ ├── Publish-VsanStoragePolicy.md │ ├── Publish-NsxtEdgeClusterHealth.md │ ├── Publish-PingConnectivityHealth.md │ ├── Publish-HardwareCompatibilityHealth.md │ ├── Request-VmOverride.md │ ├── Request-ClusterDrsRule.md │ ├── Request-ResourcePool.md │ ├── Request-ClusterConfiguration.md │ ├── Request-EsxiSecurityConfiguration.md │ ├── Request-VirtualNetwork.md │ ├── Request-VcfOverview.md │ ├── Request-VmConnectedCdrom.md │ ├── Publish-VcfSystemOverview.md │ ├── Request-NetworkOverview.md │ ├── Request-SddcManagerFreePool.md │ ├── Request-ClusterOverview.md │ ├── Request-VcenterOverview.md │ ├── Request-SddcManagerBackupStatus.md │ ├── Request-VMwareAriaSuiteOverview.md │ ├── Request-SddcManagerSnapshotStatus.md │ ├── Invoke-VcfUpgradePrecheck.md │ ├── Request-NsxtAlert.md │ ├── Request-VsanAlert.md │ ├── Request-EsxiStorageCapacity.md │ ├── Request-EsxiAlert.md │ ├── Request-EsxiConnectionHealth.md │ ├── Invoke-SddcCommand.md │ ├── Request-VcenterStorageHealth.md │ ├── Request-NsxtTransportNodeTunnelStatus.md │ ├── Request-DatastoreStorageCapacity.md │ ├── Request-NsxtVidmStatus.md │ ├── Request-NsxtTier0BgpStatus.md │ ├── Request-NsxtManagerBackupStatus.md │ ├── Request-NsxtComputeManagerStatus.md │ ├── Request-NsxtEdgeSnapshotStatus.md │ ├── Request-VcenterSnapshotStatus.md │ ├── Request-NsxtTransportNodeStatus.md │ ├── Invoke-VcfOverviewReport.md │ ├── Publish-SddcManagerFreePool.md │ ├── Publish-VmOverride.md │ ├── Request-VcenterBackupStatus.md │ └── Publish-ClusterDrsRule.md ├── .github ├── labeler-issues.yml ├── icon-400px.png ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── docs.yml │ └── enhancement.yml ├── dependabot.yml ├── labeler-pull-requests.yml ├── workflows │ ├── issues.yml │ ├── pull-requests.yml │ ├── docs.yml │ ├── lock.yml │ └── stale.yml ├── icon-400px.svg └── pull_request_template.md ├── CODEOWNERS ├── .gitignore ├── CLONE.md ├── .ci └── pester.tests.ps1 ├── Makefile ├── NOTICE ├── LICENSE └── README.md /docs/license.md: -------------------------------------------------------------------------------- 1 | --8<-- "./LICENSE" 2 | -------------------------------------------------------------------------------- /docs/release-notes.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CHANGELOG.md" 2 | -------------------------------------------------------------------------------- /docs/snippets/pre-req-linux.sh: -------------------------------------------------------------------------------- 1 | mkdir /home/modules -------------------------------------------------------------------------------- /docs/community/contributing.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CONTRIBUTING.md" 2 | -------------------------------------------------------------------------------- /docs/snippets/vars-linux.ps1: -------------------------------------------------------------------------------- 1 | $reportPath = "[report_path]" 2 | -------------------------------------------------------------------------------- /.github/labeler-issues.yml: -------------------------------------------------------------------------------- 1 | --- 2 | pending-review: 3 | - '.*' 4 | -------------------------------------------------------------------------------- /docs/community/code-of-conduct.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CODE_OF_CONDUCT.md" 2 | -------------------------------------------------------------------------------- /docs/snippets/vars-windows.ps1: -------------------------------------------------------------------------------- 1 | $reportPath = "[report_path]" 2 | -------------------------------------------------------------------------------- /docs/snippets/vars-domain.ps1: -------------------------------------------------------------------------------- 1 | $workloadDomain = "[workload_domain_name]" 2 | -------------------------------------------------------------------------------- /docs/snippets/update-module.ps1: -------------------------------------------------------------------------------- 1 | Update-Module -Name VMware.CloudFoundation.Reporting 2 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @vmware/powershell-module-for-vmware-cloud-foundation-reporting-maintainers 2 | -------------------------------------------------------------------------------- /docs/snippets/installed-module.ps1: -------------------------------------------------------------------------------- 1 | Get-InstalledModule -Name VMware.CloudFoundation.Reporting 2 | -------------------------------------------------------------------------------- /docs/assets/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | .green { 2 | color: green; 3 | } 4 | .red { 5 | color: red; 6 | } 7 | -------------------------------------------------------------------------------- /docs/snippets/vars-health.ps1: -------------------------------------------------------------------------------- 1 | $sddcManagerLocalUser = "[local_username]" 2 | $sddcManagerLocalPass = "[local_password]" 3 | -------------------------------------------------------------------------------- /docs/snippets/copy-module-local-linux.sh: -------------------------------------------------------------------------------- 1 | scp -r /home/modules/* username@remote_host:/home/lab/.local/share/powershell/Modules/ -------------------------------------------------------------------------------- /docs/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/HEAD/docs/favicon.ico -------------------------------------------------------------------------------- /.github/icon-400px.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/HEAD/.github/icon-400px.png -------------------------------------------------------------------------------- /docs/snippets/vars-vcf.ps1: -------------------------------------------------------------------------------- 1 | $sddcManagerFqdn = "[sddc_manager_fqdn]" 2 | $sddcManagerUser = "[admin_username]" 3 | $sddcManagerPass = "[admin_password]" 4 | -------------------------------------------------------------------------------- /docs/snippets/copy-module-local-windows.ps1: -------------------------------------------------------------------------------- 1 | Copy-Item -Path F:\Modules\* -Destination '\\\C$\Program Files\WindowsPowerShell\Modules\' -Recurse 2 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs-git-revision-date-localized-plugin >= 1.2.2 2 | mkdocs-markdownextradata-plugin >= 0.2.5 3 | mkdocs-minify-plugin>=0.7.2 4 | mkdocs-open-in-new-tab>=1.0.3 5 | -------------------------------------------------------------------------------- /docs/snippets/update-modules.ps1: -------------------------------------------------------------------------------- 1 | Update-Module -Name VMware.PowerCLI 2 | Update-Module -Name VMware.vSphere.SsoAdmin 3 | Update-Module -Name PowerVCF 4 | Update-Module -Name PowerValidatedSolutions 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore editor directories. 2 | .idea/ 3 | .vscode/ 4 | 5 | # Ignore temporary editor files. 6 | *~ 7 | 8 | # Ignore macOS desktop services store files. 9 | **/.DS_Store 10 | 11 | ## Ignore MkDocs site directory. 12 | **/.site/** 13 | -------------------------------------------------------------------------------- /docs/snippets/import-module.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name VMware.vSphere.SsoAdmin 3 | Import-Module -Name PowerVCF 4 | Import-Module -Name PowerValidatedSolutions 5 | Import-Module -Name VMware.CloudFoundation.Reporting 6 | -------------------------------------------------------------------------------- /docs/snippets/import-module-local-linux.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name VMware.vSphere.SsoAdmin 3 | Import-Module -Name PowerVCF 4 | Import-Module -Name PowerValidatedSolutions 5 | Import-Module -Name VMware.CloudFoundation.Reporting 6 | -------------------------------------------------------------------------------- /docs/community/index.md: -------------------------------------------------------------------------------- 1 | # Community 2 | 3 | This PowerShell module is the work of many contributors and the project team appreciates your help! 4 | 5 | Thank you for your interest in the project. Whether it's a bug report, enhancement, correction, or 6 | additional documentation, we greatly value feedback and contributions from our community. 7 | -------------------------------------------------------------------------------- /CLONE.md: -------------------------------------------------------------------------------- 1 | 2 | **Markdown** 3 | ```markdown 4 | [![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=success&label=Clone&query=count&url=https://gist.githubusercontent.com/nathanthaler/3c82845142447c9d2bdd38b0c573e33d/raw/clone.json&logo=github)](https://gist.githubusercontent.com/nathanthaler/3c82845142447c9d2bdd38b0c573e33d/raw/clone.json) 5 | ``` 6 | -------------------------------------------------------------------------------- /.ci/pester.tests.ps1: -------------------------------------------------------------------------------- 1 | Describe -Tag:('ModuleValidation') 'Module Basic Tests' { 2 | 3 | It 'is present' { 4 | $module = Get-Module -Name $moduleName 5 | $module | Should -Be $true 6 | } 7 | 8 | It ('passes Test-ModuleManifest') { 9 | Test-ModuleManifest -Path $moduleManifest | Should -Not -BeNullOrEmpty 10 | $? | Should -Be $true 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /docs/snippets/save-module-local-windows.ps1: -------------------------------------------------------------------------------- 1 | Save-Module -Name VMware.PowerCLI -Path F:\Modules\ -Repository PSGallery 2 | Save-Module -Name VMware.vSphere.SsoAdmin -Path F:\Modules\ -Repository PSGallery 3 | Save-Module -Name PowerVCF -Path F:\Modules\ -Repository PSGallery 4 | Save-Module -Name PowerValidatedSolutions -Path F:\Modules\ -Repository PSGallery 5 | Save-Module -Name VMware.CloudFoundation.Reporting -Path F:\Modules\ -Repository PSGallery 6 | -------------------------------------------------------------------------------- /docs/snippets/save-module-local-linux.ps1: -------------------------------------------------------------------------------- 1 | Save-Module -Name VMware.PowerCLI -Path /home/modules -Repository PSGallery 2 | Save-Module -Name VMware.vSphere.SsoAdmin -Path /home/modules -Repository PSGallery 3 | Save-Module -Name PowerVCF -Path /home/modules -Repository PSGallery 4 | Save-Module -Name PowerValidatedSolutions -Path /home/modules -Repository PSGallery 5 | Save-Module -Name VMware.CloudFoundation.Reporting -Path /home/modules -Repository PSGallery 6 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Copyright 2023-2024 Broadcom. All Rights Reserved. 2 | # SPDX-License-Identifier: BSD-2 3 | 4 | docs-install: 5 | pip install mkdocs-material 6 | pip install --requirement docs/requirements.txt 7 | 8 | docs-serve: 9 | mkdocs serve 10 | 11 | docs-serve-live: 12 | mkdocs serve --livereload -w ./ 13 | 14 | docs-build: 15 | mkdocs build 16 | 17 | docs-uninstall: 18 | pip uninstall mkdocs-material mkdocs -y 19 | pip uninstall --requirement docs/requirements.txt -y 20 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | © Broadcom. All Rights Reserved. 2 | The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 3 | 4 | This product is licensed to you under the BSD 2 clause (the "License"). You may not use this product except in compliance with the License. 5 | 6 | This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file. 7 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Module Documentation 4 | url: 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-reporting' 5 | about: Having trouble with the module? Check out the documentation. 6 | - name: VMware Cloud Foundation Product Documentation 7 | url: https://vmware.com/go/vcf-docs 8 | about: Manage VM and container-based workloads with the hybrid cloud platform, built on full stack hyper-converged infrastructure. 9 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 2 3 | 4 | updates: 5 | - package-ecosystem: github-actions 6 | target-branch: develop 7 | directory: / 8 | schedule: 9 | interval: weekly 10 | labels: 11 | - chore 12 | - github-actions 13 | commit-message: 14 | prefix: 'chore(gh):' 15 | 16 | - package-ecosystem: pip 17 | target-branch: develop 18 | directory: / 19 | schedule: 20 | interval: weekly 21 | labels: 22 | - chore 23 | - dependencies 24 | commit-message: 25 | prefix: 'chore(gh):' 26 | -------------------------------------------------------------------------------- /docs/snippets/install-module.ps1: -------------------------------------------------------------------------------- 1 | Set-PSRepository -Name PSGallery -InstallationPolicy Trusted 2 | Install-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Repository PSGallery -Scope AllUsers 3 | Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Repository PSGallery -Scope AllUsers 4 | Install-Module -Name PowerVCF -MinimumVersion 2.4.1 -Repository PSGallery -Scope AllUsers 5 | Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.1 -Repository PSGallery -Scope AllUsers 6 | Install-Module -Name VMware.CloudFoundation.Reporting -Repository PSGallery -Scope AllUsers 7 | -------------------------------------------------------------------------------- /.github/labeler-pull-requests.yml: -------------------------------------------------------------------------------- 1 | --- 2 | chore: 3 | - changed-files: 4 | - any-glob-to-any-file: 5 | - ".ci/**/*" 6 | - ".github/**/*" 7 | - ".gitignore" 8 | documentation: 9 | - changed-files: 10 | - any-glob-to-any-file: 11 | - "**/*.md" 12 | - "Makefile" 13 | - "**/*.md" 14 | - "mkdocs.yml" 15 | github-actions: 16 | - changed-files: 17 | - any-glob-to-any-file: 18 | - ".github/workflows/**/*" 19 | needs-review: 20 | - changed-files: 21 | - any-glob-to-any-file: 22 | - "**" 23 | -------------------------------------------------------------------------------- /.github/workflows/issues.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Issue Labels 3 | 4 | on: 5 | issues: 6 | types: 7 | - opened 8 | 9 | permissions: 10 | contents: read 11 | 12 | jobs: 13 | label-issues: 14 | runs-on: ubuntu-latest 15 | permissions: 16 | contents: read 17 | issues: write 18 | steps: 19 | - name: Apply Labels 20 | uses: github/issue-labeler@c1b0f9f52a63158c4adc09425e858e87b32e9685 # v3.4 21 | with: 22 | repo-token: ${{ secrets.GITHUB_TOKEN }} 23 | configuration-path: .github/labeler-issues.yml 24 | enable-versioned-regex: 0 25 | include-title: 1 26 | -------------------------------------------------------------------------------- /docs/user-access.md: -------------------------------------------------------------------------------- 1 | # User Access 2 | 3 | Each cmdlet may provide one or more usage examples. Many of the cmdlets require that credentials are provided to output to the PowerShell console or a report. 4 | 5 | The cmdlets in this module, and its dependencies, return data from multple platform components. The credentials for most of the platform components are returned to the cmdlets by retrieving credentials from the SDDC Manager inventory and using these credentials, as needed, within cmdlet operations. 6 | 7 | For the best expereince, for cmdlets that connect to SDDC Manager, use the VMware Cloud Foundation API user `admin@local` or an account with the **ADMIN** role in SDDC Manager (e.g., `administrator@vsphere.local`). 8 | -------------------------------------------------------------------------------- /.github/workflows/pull-requests.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Pull Request Labels 3 | 4 | on: 5 | pull_request_target: 6 | branches: 7 | - develop 8 | types: 9 | - opened 10 | - synchronize 11 | - reopened 12 | - edited 13 | - ready_for_review 14 | 15 | permissions: 16 | contents: read 17 | 18 | jobs: 19 | labeler: 20 | name: Labeler 21 | runs-on: ubuntu-latest 22 | permissions: 23 | contents: read 24 | pull-requests: write 25 | steps: 26 | - name: Apply Labels 27 | uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0 28 | with: 29 | repo-token: ${{ secrets.GITHUB_TOKEN }} 30 | configuration-path: .github/labeler-pull-requests.yml 31 | 32 | -------------------------------------------------------------------------------- /docs/update.md: -------------------------------------------------------------------------------- 1 | # Updating the Module 2 | 3 | Update the PowerShell module from the PowerShell Gallery by running the following commands: 4 | 5 | ```powershell 6 | --8<-- "./docs/snippets/update-module.ps1" 7 | ``` 8 | 9 | To verify that the PowerShell module is updated, run the following command in the PowerShell console. 10 | 11 | ```powershell 12 | --8<-- "./docs/snippets/installed-module.ps1" 13 | ``` 14 | 15 | To verify the [module dependencies](index.md#module-dependencies) meet the minimum requirements, use the [`Test-VcfReportingPrereq`](./documentation/functions/Test-VcfReportingPrereq.md) cmdlet. 16 | 17 | If a dependency does not meet the minimum requirements, run the appropriate `Update-Module` command for the dependency in the PowerShell console. 18 | 19 | ```powershell 20 | --8<-- "./docs/snippets/update-modules.ps1" 21 | ``` 22 | -------------------------------------------------------------------------------- /.github/workflows/docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Publish Documentation 3 | 4 | on: 5 | workflow_dispatch: 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | publish-docs: 12 | runs-on: ubuntu-latest 13 | permissions: 14 | contents: write 15 | steps: 16 | - name: Checkout Repository 17 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 18 | with: 19 | fetch-depth: 0 20 | - name: Setup Python 21 | uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 22 | with: 23 | python-version: 3.x 24 | - name: Install Dependencies 25 | run: | 26 | pip install mkdocs-material 27 | pip install --requirement docs/requirements.txt 28 | - name: Publish Documentation 29 | run: | 30 | mkdocs gh-deploy --force 31 | if: ${{ success() }} 32 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 2-Clause License 2 | 3 | © Broadcom. All Rights Reserved. 4 | The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 5 | 6 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 7 | following conditions are met: 8 | 9 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the 10 | following disclaimer. 11 | 12 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 13 | following disclaimer in the documentation and/or other materials provided with the distribution. 14 | 15 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 16 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 17 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 18 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 19 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 20 | WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 21 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 22 | -------------------------------------------------------------------------------- /.github/workflows/lock.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Lock 3 | 4 | on: 5 | schedule: 6 | - cron: 30 00 * * * 7 | 8 | permissions: 9 | contents: read 10 | 11 | jobs: 12 | lock: 13 | runs-on: ubuntu-latest 14 | permissions: 15 | issues: write 16 | pull-requests: write 17 | discussions: write 18 | steps: 19 | - uses: dessant/lock-threads@7266a7ce5c1df01b1c6db85bf8cd86c737dadbe7 # v6.0.0 20 | with: 21 | github-token: "${{ secrets.GITHUB_TOKEN }}" 22 | issue-comment: >- 23 | I'm going to lock this issue because it has been closed for 30 24 | days. This helps our maintainers find and focus on the active 25 | issues. 26 | 27 | 28 | If you have found a problem that seems similar to this, 29 | please open a new issue and complete the issue template so we can 30 | capture all the details necessary to investigate further. 31 | issue-inactive-days: "30" 32 | pr-comment: >- 33 | I'm going to lock this pull request because it has been closed for 34 | 30 days. This helps our maintainers find and focus on the active 35 | issues. 36 | 37 | 38 | If you have found a problem that seems related to this 39 | change, please open a new issue and complete the issue template so 40 | we can capture all the details necessary to investigate further. 41 | pr-inactive-days: "30" 42 | -------------------------------------------------------------------------------- /.github/icon-400px.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/assets/images/icon-color.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/documentation/getting-started/upgrade-precheck-report.md: -------------------------------------------------------------------------------- 1 | # Generating an Upgrade Precheck Report 2 | 3 | The [`Invoke-VcfUpgradePrecheck`](../functions/Invoke-VcfUpgradePrecheck.md) cmdlet initiates an upgrade precheck of a workload domain using the REST API and presents the results in an HTML report. This allows you to start the precheck from the PowerShell console. 4 | 5 | ## Start an Upgrade Precheck for a Workload Domain 6 | 7 | 1. Start PowerShell (Run as Administrator). 8 | 9 | 2. Replace the values in the sample code with values for the instance of VMware Cloud Foundation to generate an upgrade precheck report for SDDC Manager instance and run the commands in the PowerShell console. 10 | 11 | **Example**: 12 | 13 | === ":fontawesome-brands-windows:   Windows" 14 | 15 | ```powershell 16 | --8<-- "./docs/snippets/vars-vcf.ps1" 17 | --8<-- "./docs/snippets/vars-domain.ps1" 18 | --8<-- "./docs/snippets/vars-windows.ps1" 19 | ``` 20 | 21 | === ":fontawesome-brands-linux:   Linux" 22 | 23 | ```powershell 24 | --8<-- "./docs/snippets/vars-vcf.ps1" 25 | --8<-- "./docs/snippets/vars-domain.ps1" 26 | --8<-- "./docs/snippets/vars-linux.ps1" 27 | ``` 28 | 3. Generate the report by running the command in the PowerShell console. 29 | 30 | ```powershell 31 | Invoke-VcfUpgradePrecheck -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass -reportPath $reportPath -workloadDomain $workloadDomain 32 | ``` 33 | 34 | 4. Review the generated HTML report. 35 | -------------------------------------------------------------------------------- /docs/community/support.md: -------------------------------------------------------------------------------- 1 | # Support 2 | 3 | :octicons-heart-24:   This module is community-driven and maintained by the project 4 | contributors. It is not officially supported by Broadcom Support but thrives on collaboration and 5 | input from its users. 6 | 7 | :octicons-issue-opened-24:   Use the GitHub [issues][issues] to report bugs or suggest 8 | enhancements. 9 | 10 | :octicons-thumbsup-24:   Issues are monitored by the maintainers and are prioritized based on 11 | criticality and community [reactions][reactions]. 12 | 13 | :octicons-search-24:   Before opening an issue, please [search the issues][issues-search] and 14 | use the reactions to add votes to matching issues. Please include as much information as you can. 15 | Details like these are incredibly useful in helping the us evaluate and prioritize any changes: 16 | 17 | - A reproducible test case or series of steps. 18 | - Any modifications you've made relevant to the bug. 19 | - Anything unusual about your environment or deployment. 20 | 21 | :octicons-comment-discussion-24:   You can also start a discussion on the GitHub [discussions][discussions] 22 | area to ask questions or share ideas. 23 | 24 | [issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues 25 | [issues-search]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues?q=is%3Aissue+is%3Aopen+label%3Abug 26 | [discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/discussions 27 | [reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ 28 | -------------------------------------------------------------------------------- /docs/documentation/getting-started/overview-report.md: -------------------------------------------------------------------------------- 1 | # Generating an Overview Report 2 | 3 | The [`Invoke-VcfOverviewReport`](../functions/Invoke-VcfOverviewReport.md) cmdlet generates a system overview report. This report contains high-level information about the VMware Cloud Foundation Instance. This report may be used to provide a quick system overview of the system to your VMware representative. 4 | 5 | ## Generate an Overview Report for a VMware Cloud Foundation Instance 6 | 7 | 1. Start PowerShell (Run as Administrator). 8 | 9 | 2. Replace the values in the sample code with values for the instance of VMware Cloud Foundation to generate a system overview report for SDDC Manager instance and run the commands in the PowerShell console. 10 | 11 | **Example**: 12 | 13 | === ":fontawesome-brands-windows:   Windows" 14 | 15 | ```powershell 16 | --8<-- "./docs/snippets/vars-vcf.ps1" 17 | --8<-- "./docs/snippets/vars-windows.ps1" 18 | ``` 19 | 20 | === ":fontawesome-brands-linux:   Linux" 21 | 22 | ```powershell 23 | --8<-- "./docs/snippets/vars-vcf.ps1" 24 | --8<-- "./docs/snippets/vars-linux.ps1" 25 | ``` 26 | 27 | 3. Generate the report by running the command in the PowerShell console. 28 | 29 | ```powershell 30 | Invoke-VcfOverviewReport -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass -reportPath $reportPath 31 | ``` 32 | 33 | If you prefer to anonymize the data, you can use the `-anonymized` parameter. 34 | 35 | ```powershell 36 | Invoke-VcfOverviewReport -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass -reportPath $reportPath -anonymized 37 | ``` 38 | 39 | 4. Review the generated HTML report. 40 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Stale 3 | 4 | on: 5 | schedule: 6 | - cron: 00 00 * * * 7 | 8 | permissions: 9 | contents: read 10 | 11 | jobs: 12 | stale: 13 | runs-on: ubuntu-latest 14 | permissions: 15 | contents: read 16 | issues: write 17 | pull-requests: write 18 | steps: 19 | - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1 20 | with: 21 | repo-token: ${{ secrets.GITHUB_TOKEN }} 22 | days-before-stale: 60 23 | days-before-close: 30 24 | exempt-issue-labels: needs-triage 25 | exempt-pr-labels: needs-review 26 | exempt-all-assignees: true 27 | remove-stale-when-updated: true 28 | delete-branch: false 29 | stale-issue-label: stale 30 | stale-issue-message: > 31 | Marking this issue as stale due to inactivity. This helps us focus 32 | on the active issues. If this issue receives no comments in the next 33 | 30 days it will automatically be closed. 34 | 35 | 36 | If this issue was automatically closed and you feel this issue 37 | should be reopened, we encourage creating a new issue linking back 38 | to this one for added context. 39 | stale-pr-label: stale 40 | stale-pr-message: > 41 | Marking this pull request as stale due to inactivity. This helps us 42 | focus on the active pull requests. If this pull request receives no 43 | comments in the next 30 days it will automatically be closed. 44 | 45 | 46 | If this pull request was automatically closed and you feel this pull 47 | request should be reopened, we encourage creating a new pull request 48 | linking back to this one for added context. 49 | -------------------------------------------------------------------------------- /docs/assets/images/icon-white.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 8 | 11 | 14 | 19 | 23 | 24 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Documentation 3 | description: Found a typo or something that needs clarification? 4 | title: 'Please add a short description.' 5 | labels: ["documentation", "needs-review"] 6 | projects: ["vmware/22"] 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: > 11 | When filing a documentation issue, please include the following information. 12 | - type: checkboxes 13 | id: terms 14 | attributes: 15 | label: Code of Conduct 16 | description: >- 17 | This project has a [Code of Conduct](https://github.com/vmware/powershell-module-for-cloud-foundation-reporting/blob/main/CODE_OF_CONDUCT.md) 18 | that all participants are expected to understand and follow. 19 | options: 20 | - label: I have read and agree to the project's Code of Conduct. 21 | required: true 22 | - type: input 23 | id: version-module 24 | attributes: 25 | label: Module Version 26 | description: Please provide the module version. 27 | validations: 28 | required: true 29 | - type: textarea 30 | id: motivation 31 | attributes: 32 | label: Motivation 33 | description: Why should we update our docs or examples? 34 | validations: 35 | required: false 36 | - type: textarea 37 | id: suggestion 38 | attributes: 39 | label: Suggestion 40 | description: What should we do instead? 41 | validations: 42 | required: false 43 | - type: markdown 44 | attributes: 45 | value: "### Community Note\n* Please vote on this issue by adding a \U0001F44D [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request\n* Please do not leave \"+1\" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request\n* If you are interested in working on this issue or have submitted a pull request, please leave a comment\n" 46 | -------------------------------------------------------------------------------- /docs/documentation/functions/Test-VcfReportingPrereq.md: -------------------------------------------------------------------------------- 1 | # Test-VcfReportingPrereq 2 | 3 | ## Synopsis 4 | 5 | Verifies that the minimum dependencies are met to run the PowerShell module. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Test-VcfReportingPrereq [-sddcManagerFqdn] [-sddcManagerUser] [-sddcManagerPass] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Test-VcfReportingPrereq` cmdlet checks that all the prerequisites have been met to run the PowerShell module. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Test-VcfReportingPrereq -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] 23 | ``` 24 | 25 | This example runs the prerequisite validation. 26 | 27 | ## Parameters 28 | 29 | ### -sddcManagerFqdn 30 | 31 | The fully qualified domain name of the SDDC Manager. 32 | 33 | ```yaml 34 | Type: String 35 | Parameter Sets: (All) 36 | Aliases: 37 | 38 | Required: True 39 | Position: 1 40 | Default value: None 41 | Accept pipeline input: False 42 | Accept wildcard characters: False 43 | ``` 44 | 45 | ### -sddcManagerUser 46 | 47 | The username to authenticate to the SDDC Manager. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 2 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -sddcManagerPass 62 | 63 | The password to authenticate to the SDDC Manager. 64 | 65 | ```yaml 66 | Type: String 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: True 71 | Position: 3 72 | Default value: None 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### Common Parameters 78 | 79 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 80 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-HardwareOverview.md: -------------------------------------------------------------------------------- 1 | # Request-HardwareOverview 2 | 3 | ## Synopsis 4 | 5 | Returns hardware overview. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-HardwareOverview [-server] [-user] [-pass] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcfOverview` cmdlet returns an overview of the hardware in an SDDC Manager instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Collects the hardware details. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-HardwareOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return a hardware overview of the SDDC Manager instance. 30 | 31 | ## Parameters 32 | 33 | ### -server 34 | 35 | The fully qualified domain name of the SDDC Manager. 36 | 37 | ```yaml 38 | Type: String 39 | Parameter Sets: (All) 40 | Aliases: 41 | 42 | Required: True 43 | Position: 1 44 | Default value: None 45 | Accept pipeline input: False 46 | Accept wildcard characters: False 47 | ``` 48 | 49 | ### -user 50 | 51 | The username to authenticate to the SDDC Manager. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: 2 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -pass 66 | 67 | The password to authenticate to the SDDC Manager. 68 | 69 | ```yaml 70 | Type: String 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: True 75 | Position: 3 76 | Default value: None 77 | Accept pipeline input: False 78 | Accept wildcard characters: False 79 | ``` 80 | 81 | ### Common Parameters 82 | 83 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 84 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-ValidatedSolutionOverview.md: -------------------------------------------------------------------------------- 1 | # Request-ValidatedSolutionOverview 2 | 3 | ## Synopsis 4 | 5 | Returns VMware Validated Solution overview. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-ValidatedSolutionOverview [-server] [-user] [-pass] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-ValidatedSolutionOverview` cmdlet returns an overview of VMware Validated Solutions that are deployed. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Collects the VMware Validated Solution details. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-ValidatedSolutionOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return an overview of VMware Validated Solutions that are deployed. 30 | 31 | ## Parameters 32 | 33 | ### -server 34 | 35 | The fully qualified domain name of the SDDC Manager. 36 | 37 | ```yaml 38 | Type: String 39 | Parameter Sets: (All) 40 | Aliases: 41 | 42 | Required: True 43 | Position: 1 44 | Default value: None 45 | Accept pipeline input: False 46 | Accept wildcard characters: False 47 | ``` 48 | 49 | ### -user 50 | 51 | The username to authenticate to the SDDC Manager. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: 2 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -pass 66 | 67 | The password to authenticate to the SDDC Manager. 68 | 69 | ```yaml 70 | Type: String 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: True 75 | Position: 3 76 | Default value: None 77 | Accept pipeline input: False 78 | Accept wildcard characters: False 79 | ``` 80 | 81 | ### Common Parameters 82 | 83 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 84 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/enhancement.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Enhancement Request 3 | description: Is something critical missing? Suggest an enhancement. 4 | title: 'Please add a short description.' 5 | labels: ["enhancement", "needs-review"] 6 | projects: ["vmware/22"] 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: > 11 | Before filing an enhancement, please search the existing issues and use the 12 | [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) 13 | feature to add up-votes to existing requests. 14 | 15 | 16 | When filing an enhancement, please include the following information. 17 | - type: checkboxes 18 | id: terms 19 | attributes: 20 | label: Code of Conduct 21 | description: >- 22 | This project has a [Code of 23 | Conduct](https://github.com/vmware/powershell-module-for-cloud-foundation-reporting/blob/main/CODE_OF_CONDUCT.md) 24 | that all participants are expected to understand and follow. 25 | options: 26 | - label: I have read and agree to the project's Code of Conduct. 27 | required: true 28 | - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue initial description to help the maintainers prioritize. 29 | required: false 30 | - label: Do not leave "+1" or other comments that do not add relevant information or questions. 31 | required: false 32 | - label: If you are interested in working on this issue or have submitted a pull request, please leave a comment. 33 | required: false 34 | - type: textarea 35 | id: description 36 | attributes: 37 | label: Description 38 | description: A written overview of the enhancement. 39 | validations: 40 | required: true 41 | - type: textarea 42 | id: use-case 43 | attributes: 44 | label: Use Case(s) 45 | description: Any relevant use-cases that you see. 46 | validations: 47 | required: true 48 | - type: textarea 49 | id: potential-configuration 50 | attributes: 51 | label: Potential Configuration 52 | description: Provide a potential configuration. 53 | validations: 54 | required: true 55 | - type: textarea 56 | id: references 57 | attributes: 58 | label: References 59 | description: Provide any references. 60 | validations: 61 | required: false 62 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-DnsHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-DnsHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the DNS health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-DnsHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-DnsHealth` cmdlet formats the DNS health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-DnsHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the DNS health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-DnsHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the DNS health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-DnsHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the DNS health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-NtpHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-NtpHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the NTP health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-NtpHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-NtpHealth` cmdlet formats the NTP health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-NtpHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the NTP health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-NtpHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the NTP health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-NtpHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the NTP health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-EsxiHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-EsxiHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the ESX health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-EsxiHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-EsxiHealth` cmdlet formats the ESX health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-EsxiHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the ESX health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-EsxiHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the ESX health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-EsxiHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the ESX health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-NsxtHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-NsxtHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the NSX health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-NsxtHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-NsxtHealth` cmdlet formats the NSX health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-NsxtHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the NSX health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-NsxtHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the NSX health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-NsxtHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the NSX health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-VsanHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-VsanHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the vSAN health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-VsanHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-VsanHealth` cmdlet formats the vSAN health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-VsanHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the vSAN health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-VsanHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the vSAN health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-VsanHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the vSAN health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 11 | 12 | ### Summary 13 | 14 | 17 | 18 | ### Type 19 | 20 | 23 | 24 | - [ ] Bugfix 25 | - [ ] Enhancement or Feature 26 | - [ ] Code Style or Formatting 27 | - [ ] Documentation 28 | - [ ] Refactoring 29 | - [ ] Chore 30 | - [ ] Other 31 | Please describe: 32 | 33 | ### Breaking Changes? 34 | 35 | 39 | 40 | - [ ] Yes, there are breaking changes. 41 | - [ ] No, there are no breaking changes. 42 | 43 | ### Test and Documentation 44 | 45 | 49 | 50 | - [ ] Tests have been completed. 51 | - [ ] Documentation has been added or updated. 52 | 53 | 56 | 57 | ### Issue References 58 | 59 | 72 | 73 | ### Additional Information 74 | 75 | 78 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-ServiceHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-ServiceHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the service health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-ServiceHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-ServiceHealth` cmdlet formats the service health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-ServiceHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the service health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-ServiceHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the service health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-ServiceHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the service health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-VcenterHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-VcenterHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the vCenter health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-VcenterHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-VcenterHealth` cmdlet formats the vCenter health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-VcenterHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the vCenter health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-VcenterHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the vCenter health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-VcenterHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the vCenter health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-VersionHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-VersionHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the version health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-VersionHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-VersionHealth` cmdlet formats the version health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-VersionHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the version health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-VersionHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the version health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-VersionHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the version health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-PasswordHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-PasswordHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the password health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-PasswordHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-PasswordHealth` cmdlet formats the password health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-PasswordHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the password health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-PasswordHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the password health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-PasswordHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the password health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-ConnectivityHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-ConnectivityHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the connectivity health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-ConnectivityHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-ConnectivityHealth` cmdlet formats the connectivity health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-ConnectivityHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the connectivity health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-ConnectivityHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the connectivity health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-ConnectivityHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the connectivity health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Switch to only output issues to the report. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-CertificateHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-CertificateHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the certificate health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-CertificateHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-CertificateHealth` cmdlet formats the certificate health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-CertificateHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the certificate health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-CertificateHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the certificate health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-CertificateHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the certificate health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-NsxtEdgeNodeHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-NsxtEdgeNodeHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the NSX Edge Node health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-NsxtEdgeNodeHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-NsxtEdgeNodeHealth` cmdlet formats the NSX Edge Node health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-NsxtEdgeNodeHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the NSX Edge Node health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-NsxtEdgeNodeHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the NSX Edge Node health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-NsxtEdgeNodeHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the NSX Edge Node health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-VsanStoragePolicy.md: -------------------------------------------------------------------------------- 1 | # Publish-VsanStoragePolicy 2 | 3 | ## Synopsis 4 | 5 | Formats the vSAN storage policy for virtual machines from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-VsanStoragePolicy [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-VsanStoragePolicy` cmdlet formats the vSAN storage policy data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-VsanStoragePolicy -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the vSAN storage policy data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-VsanStoragePolicy -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the vSAN storage policy data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-VsanStoragePolicy -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the vSAN storage policy data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-NsxtEdgeClusterHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-NsxtEdgeClusterHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the NSX Edge Cluster health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-NsxtEdgeClusterHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-NsxtEdgeClusterHealth` cmdlet formats the NSX Edge Cluster health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-NsxtEdgeClusterHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the NSX Edge Cluster health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-NsxtEdgeClusterHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the NSX Edge Cluster health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-NsxtEdgeClusterHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the NSX Edge Cluster health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/getting-started/configuration-report.md: -------------------------------------------------------------------------------- 1 | # Generating Configuration Reports 2 | 3 | The [`Invoke-VcfConfigReport`](../functions/Invoke-VcfConfigReport.md) cmdlet generates a configuration report. This report collects information about the configuration settings in a VMware Cloud Foundation Instance for the platform components. This report reduces the need to login to multiple product interfaces and endpoints to collect information about the configuration. 4 | 5 | ## VMware Cloud Foundation Instance 6 | 7 | 1. Start PowerShell (Run as Administrator). 8 | 9 | 2. Replace the values in the sample code with values for the instance of VMware Cloud Foundation to generate a configuration report for SDDC Manager instance and run the commands in the PowerShell console. 10 | 11 | **Example**: 12 | 13 | === ":fontawesome-brands-windows:   Windows" 14 | 15 | ```powershell 16 | --8<-- "./docs/snippets/vars-vcf.ps1" 17 | --8<-- "./docs/snippets/vars-windows.ps1" 18 | ``` 19 | 20 | === ":fontawesome-brands-linux:   Linux" 21 | 22 | ```powershell 23 | --8<-- "./docs/snippets/vars-vcf.ps1" 24 | --8<-- "./docs/snippets/vars-linux.ps1" 25 | ``` 26 | 27 | 3. Generate the report by running the command in the PowerShell console. 28 | 29 | ```powershell 30 | Invoke-VcfConfigReport -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass -reportPath $reportPath -allDomains 31 | ``` 32 | 33 | 4. Review the generated HTML report. 34 | 35 | ## Workload Domain 36 | 37 | 1. Start PowerShell (Run as Administrator). 38 | 39 | 2. Replace the values in the sample code with values for the instance of VMware Cloud Foundation to generate a configuration report for SDDC Manager instance and run the commands in the PowerShell console. 40 | 41 | **Example**: 42 | 43 | === ":fontawesome-brands-windows:   Windows" 44 | 45 | ```powershell 46 | --8<-- "./docs/snippets/vars-vcf.ps1" 47 | --8<-- "./docs/snippets/vars-domain.ps1" 48 | --8<-- "./docs/snippets/vars-windows.ps1" 49 | ``` 50 | 51 | === ":fontawesome-brands-linux:   Linux" 52 | 53 | ```powershell 54 | --8<-- "./docs/snippets/vars-vcf.ps1" 55 | --8<-- "./docs/snippets/vars-domain.ps1" 56 | --8<-- "./docs/snippets/vars-linux.ps1" 57 | ``` 58 | 59 | 3. Generate the report by running the command in the PowerShell console. 60 | 61 | ```powershell 62 | Invoke-VcfConfigReport -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass -reportPath $reportPath -workloadDomain $workloadDomain 63 | ``` 64 | 65 | 4. Review the generated HTML report. 66 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-PingConnectivityHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-PingConnectivityHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the ping connectivity health data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-PingConnectivityHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-PingConnectivityHealth` cmdlet formats the ping connectivity health data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-PingConnectivityHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the ping connectivity health data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-PingConnectivityHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the ping connectivity health data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-PingConnectivityHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the ping connectivity health data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-HardwareCompatibilityHealth.md: -------------------------------------------------------------------------------- 1 | # Publish-HardwareCompatibilityHealth 2 | 3 | ## Synopsis 4 | 5 | Formats the Hardware Compatibility data from the SoS JSON output. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-HardwareCompatibilityHealth [-json] [-html] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-HardwareCompatibilityHealth` cmdlet formats the hardware compatibility data from the SoS JSON output and publishes it as either a standard PowerShell object or an HTML object. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Publish-HardwareCompatibilityHealth -json [file_name] 23 | ``` 24 | 25 | This example extracts and formats the hardware compatibility data as a PowerShell object from the JSON file. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Publish-HardwareCompatibilityHealth -json [file_name] -html 31 | ``` 32 | 33 | This example extracts and formats the hardware compatibility data as an HTML object from the JSON file. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Publish-HardwareCompatibilityHealth -json [file_name] -failureOnly 39 | ``` 40 | 41 | This example extracts and formats the hardware compatibility data as a PowerShell object from the JSON file for only the failed items. 42 | 43 | ## Parameters 44 | 45 | ### -json 46 | 47 | The path to the JSON file containing the SoS health summary data. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -html 62 | 63 | Specifies that the output should be formatted as an HTML object. 64 | 65 | ```yaml 66 | Type: SwitchParameter 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: Named 72 | Default value: False 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -failureOnly 78 | 79 | Specifies that the output should only contain failed items. 80 | 81 | ```yaml 82 | Type: SwitchParameter 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: Named 88 | Default value: False 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### Common Parameters 94 | 95 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 96 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VmOverride.md: -------------------------------------------------------------------------------- 1 | # Request-VmOverride 2 | 3 | ## Synopsis 4 | 5 | Gets the VM override setting from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VmOverride [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VmOverride` cmdlets gets the VM override setting for a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the VM override settings from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VmOverride -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example gets the VM override setting for a vCenter instance based on a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-ClusterDrsRule.md: -------------------------------------------------------------------------------- 1 | # Request-ClusterDrsRule 2 | 3 | ## Synopsis 4 | 5 | Gets cluster DRS rules from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-ClusterDrsRule [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-ClusterDrsRule` cmdlets gets the cluster DRS rules for a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the cluster DRS rules from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-ClusterDrsRule -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] 28 | ``` 29 | 30 | This example gets the cluster DRS rules for a vCenter instance for a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-ResourcePool.md: -------------------------------------------------------------------------------- 1 | # Request-ResourcePool 2 | 3 | ## Synopsis 4 | 5 | Gets resource pool details from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-ResourcePool [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-ResourcePool` cmdlets gets the resource pool details for a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the resource pool details from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-ResourcePool -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example gets the resource pool details for a vCenter instance based on a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-ClusterConfiguration.md: -------------------------------------------------------------------------------- 1 | # Request-ClusterConfiguration 2 | 3 | ## Synopsis 4 | 5 | Gets cluster configuration from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-ClusterConfiguration [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-ClusterConfiguration` cmdlets gets the cluster configuration for a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the cluster details from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-ClusterConfiguration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example gets the cluster configuration for a vCenter instance based on a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-EsxiSecurityConfiguration.md: -------------------------------------------------------------------------------- 1 | # Request-EsxiSecurityConfiguration 2 | 3 | ## Synopsis 4 | 5 | Gets ESX security configuration from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-EsxiSecurityConfiguration [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-EsxiSecurityConfiguration` cmdlets gets ESX security configuration for a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the ESX security configuration from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-EsxiSecurityConfiguration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example gets the ESX security configuration for a vCenter instance based on a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VirtualNetwork.md: -------------------------------------------------------------------------------- 1 | # Request-VirtualNetwork 2 | 3 | ## Synopsis 4 | 5 | Gets vSphere virtual networking configuration from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VirtualNetwork [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VirtualNetwork` cmdlets gets vSphere virtual networking configuration for a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the vSphere virtual networking configuration from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VirtualNetwork -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example gets the vSphere virtual networking configuration for a vCenter instance managed by SDDC Manager a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcfOverview.md: -------------------------------------------------------------------------------- 1 | # Request-VcfOverview 2 | 3 | ## Synopsis 4 | 5 | Returns an overview of the SDDC Manager instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcfOverview [-server] [-user] [-pass] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcfOverview` cmdlet returns an overview of the SDDC Manager instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Collects the overview detail. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-VcfOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return an overview of the SDDC Manager instance. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-VcfOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized 35 | ``` 36 | 37 | This example will return an overview of the SDDC Manager instance, but will anonymize the output. 38 | 39 | ## Parameters 40 | 41 | ### -server 42 | 43 | The fully qualified domain name of the SDDC Manager. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -user 58 | 59 | The username to authenticate to the SDDC Manager. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: True 67 | Position: 2 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -pass 74 | 75 | The password to authenticate to the SDDC Manager. 76 | 77 | ```yaml 78 | Type: String 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: True 83 | Position: 3 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### -anonymized 90 | 91 | Switch to enable anonymized output for the report. 92 | 93 | ```yaml 94 | Type: SwitchParameter 95 | Parameter Sets: (All) 96 | Aliases: 97 | 98 | Required: False 99 | Position: Named 100 | Default value: False 101 | Accept pipeline input: False 102 | Accept wildcard characters: False 103 | ``` 104 | 105 | ### Common Parameters 106 | 107 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 108 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VmConnectedCdrom.md: -------------------------------------------------------------------------------- 1 | # Request-VmConnectedCdrom 2 | 3 | ## Synopsis 4 | 5 | Returns the status of virtual machines with connected CD-ROMs in a specified workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VmConnectedCdrom [-server] [-user] [-pass] [-domain] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VmConnectedCdrom` cmdlet returns the status of virtual machines with connected CD-ROMs in a specified workload domain. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the status of virtual machines with connected CD-ROMs in a specified workload domain. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VmConnectedCdrom -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example returns the status of virtual machines with connected CD-ROMs in a specified workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to run against. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### Common Parameters 99 | 100 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 101 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-VcfSystemOverview.md: -------------------------------------------------------------------------------- 1 | # Publish-VcfSystemOverview 2 | 3 | ## Synopsis 4 | 5 | Publishs a system overview report. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-VcfSystemOverview [-server] [-user] [-pass] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-VcfSystemOverview` cmdlet returns an overview of the Vmware Cloud Foundation instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Collects the system overview details from the environment. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Publish-VcfSystemOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return system overview report for all workload domains. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Publish-VcfSystemOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized 35 | ``` 36 | 37 | This example will return system overview report for all workload domains, but with anonymized data. 38 | 39 | ## Parameters 40 | 41 | ### -server 42 | 43 | The fully qualified domain name of the SDDC Manager. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -user 58 | 59 | The username to authenticate to the SDDC Manager. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: True 67 | Position: 2 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -pass 74 | 75 | The password to authenticate to the SDDC Manager. 76 | 77 | ```yaml 78 | Type: String 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: True 83 | Position: 3 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### -anonymized 90 | 91 | Switch to enable anonymized output for the report. 92 | 93 | ```yaml 94 | Type: SwitchParameter 95 | Parameter Sets: (All) 96 | Aliases: 97 | 98 | Required: False 99 | Position: Named 100 | Default value: False 101 | Accept pipeline input: False 102 | Accept wildcard characters: False 103 | ``` 104 | 105 | ### Common Parameters 106 | 107 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 108 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NetworkOverview.md: -------------------------------------------------------------------------------- 1 | # Request-NetworkOverview 2 | 3 | ## Synopsis 4 | 5 | Returns overview of networking. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NetworkOverview [-server] [-user] [-pass] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NetworkOverview` cmdlet returns an overview of the networking managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication to the SDDC Manager instance. 19 | - Collects the networking overview detail. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-NetworkOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return an overview of the networking managed by the SDDC Manager instance. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-NetworkOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized 35 | ``` 36 | 37 | This example will return an overview of the networking managed by the SDDC Manager instance, but will anonymize the output. 38 | 39 | ## Parameters 40 | 41 | ### -server 42 | 43 | The fully qualified domain name of the SDDC Manager. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -user 58 | 59 | The username to authenticate to the SDDC Manager. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: True 67 | Position: 2 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -pass 74 | 75 | The password to authenticate to the SDDC Manager. 76 | 77 | ```yaml 78 | Type: String 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: True 83 | Position: 3 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### -anonymized 90 | 91 | Switch to enable anonymized output for the report. 92 | 93 | ```yaml 94 | Type: SwitchParameter 95 | Parameter Sets: (All) 96 | Aliases: 97 | 98 | Required: False 99 | Position: Named 100 | Default value: False 101 | Accept pipeline input: False 102 | Accept wildcard characters: False 103 | ``` 104 | 105 | ### Common Parameters 106 | 107 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 108 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SddcManagerFreePool.md: -------------------------------------------------------------------------------- 1 | # Request-SddcManagerFreePool 2 | 3 | ## Synopsis 4 | 5 | Returns the status of the ESX hosts in the free pool managed by SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SddcManagerFreePool [-server] [-user] [-pass] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SddcManagerFreePool` cmdlet returns status of the ESX hosts in the free pool managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to the SDDC Manager instance. 19 | - Gathers the details for the ESX hosts in the free pool. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-SddcManagerFreePool -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return the ESX hosts in the free pool managed by SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-SddcManagerFreePool -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -failureOnly 35 | ``` 36 | 37 | This example will return the ESX hosts in the free pool managed by SDDC Manager for a workload domain but only reports issues. 38 | 39 | ## Parameters 40 | 41 | ### -server 42 | 43 | The fully qualified domain name of the SDDC Manager. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -user 58 | 59 | The username to authenticate to the SDDC Manager. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: True 67 | Position: 2 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -pass 74 | 75 | The password to authenticate to the SDDC Manager. 76 | 77 | ```yaml 78 | Type: String 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: True 83 | Position: 3 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### -failureOnly 90 | 91 | Switch to only output issues to the report. 92 | 93 | ```yaml 94 | Type: SwitchParameter 95 | Parameter Sets: (All) 96 | Aliases: 97 | 98 | Required: False 99 | Position: Named 100 | Default value: False 101 | Accept pipeline input: False 102 | Accept wildcard characters: False 103 | ``` 104 | 105 | ### Common Parameters 106 | 107 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 108 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-ClusterOverview.md: -------------------------------------------------------------------------------- 1 | # Request-ClusterOverview 2 | 3 | ## Synopsis 4 | 5 | Returns an overview of vSphere. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-ClusterOverview [-server] [-user] [-pass] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-ClusterOverview` cmdlet returns an overview of the vSphere environment managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication to the SDDC Manager instance. 19 | - Validates that network connectivity and authentication to the vCenter instances. 20 | - Collects the vSphere overview detail. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-ClusterOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 28 | ``` 29 | 30 | This example will return an overview of the vSphere environment managed by the SDDC Manager instance. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-ClusterOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized 36 | ``` 37 | 38 | This example will return an overview of the vSphere environment managed by the SDDC Manager instance, but will anonymize the output. 39 | 40 | ## Parameters 41 | 42 | ### -server 43 | 44 | The fully qualified domain name of the SDDC Manager. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: True 52 | Position: 1 53 | Default value: None 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -user 59 | 60 | The username to authenticate to the SDDC Manager. 61 | 62 | ```yaml 63 | Type: String 64 | Parameter Sets: (All) 65 | Aliases: 66 | 67 | Required: True 68 | Position: 2 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -pass 75 | 76 | The password to authenticate to the SDDC Manager. 77 | 78 | ```yaml 79 | Type: String 80 | Parameter Sets: (All) 81 | Aliases: 82 | 83 | Required: True 84 | Position: 3 85 | Default value: None 86 | Accept pipeline input: False 87 | Accept wildcard characters: False 88 | ``` 89 | 90 | ### -anonymized 91 | 92 | Switch to enable anonymized output for the report. 93 | 94 | ```yaml 95 | Type: SwitchParameter 96 | Parameter Sets: (All) 97 | Aliases: 98 | 99 | Required: False 100 | Position: Named 101 | Default value: False 102 | Accept pipeline input: False 103 | Accept wildcard characters: False 104 | ``` 105 | 106 | ### Common Parameters 107 | 108 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 109 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterOverview.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterOverview 2 | 3 | ## Synopsis 4 | 5 | Returns an overview of vSphere. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterOverview [-server] [-user] [-pass] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterOverview` cmdlet returns an overview of the vSphere environment managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is available to the SDDC Manager instance. 19 | - Validates that network connectivity and authentication is available to the vCenter instances. 20 | - Collects the vSphere overview detail. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VcenterOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 28 | ``` 29 | 30 | This example will return an overview of the vSphere environment managed by SDDC Manager. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-VcenterOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized 36 | ``` 37 | 38 | This example will return an overview of the vSphere environment managed by SDDC Manager, but will anonymize the output. 39 | 40 | ## Parameters 41 | 42 | ### -server 43 | 44 | The fully qualified domain name of the SDDC Manager. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: True 52 | Position: 1 53 | Default value: None 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -user 59 | 60 | The username to authenticate to the SDDC Manager. 61 | 62 | ```yaml 63 | Type: String 64 | Parameter Sets: (All) 65 | Aliases: 66 | 67 | Required: True 68 | Position: 2 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -pass 75 | 76 | The password to authenticate to the SDDC Manager. 77 | 78 | ```yaml 79 | Type: String 80 | Parameter Sets: (All) 81 | Aliases: 82 | 83 | Required: True 84 | Position: 3 85 | Default value: None 86 | Accept pipeline input: False 87 | Accept wildcard characters: False 88 | ``` 89 | 90 | ### -anonymized 91 | 92 | Switch to enable anonymized output for the report. 93 | 94 | ```yaml 95 | Type: SwitchParameter 96 | Parameter Sets: (All) 97 | Aliases: 98 | 99 | Required: False 100 | Position: Named 101 | Default value: False 102 | Accept pipeline input: False 103 | Accept wildcard characters: False 104 | ``` 105 | 106 | ### Common Parameters 107 | 108 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 109 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SddcManagerBackupStatus.md: -------------------------------------------------------------------------------- 1 | # Request-SddcManagerBackupStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of the file-level latest backup task in an SDDC Manager instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SddcManagerBackupStatus [-server] [-user] [-pass] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SddcManagerBackupStatus` cmdlet returns the status of the latest file-level backup task in an SDDC Manager instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Collects the latest file-level backup status details. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-SddcManagerBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return the status of the latest file-level backup task in an SDDC Manager instance. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-SddcManagerBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -failureOnly 35 | ``` 36 | 37 | This example will return the status of the latest file-level backup task in an SDDC Manager instance but only reports issues. 38 | 39 | ## Parameters 40 | 41 | ### -server 42 | 43 | The fully qualified domain name of the SDDC Manager. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -user 58 | 59 | The username to authenticate to the SDDC Manager. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: True 67 | Position: 2 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -pass 74 | 75 | The password to authenticate to the SDDC Manager. 76 | 77 | ```yaml 78 | Type: String 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: True 83 | Position: 3 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### -failureOnly 90 | 91 | Switch to only output issues to the report. 92 | 93 | ```yaml 94 | Type: SwitchParameter 95 | Parameter Sets: (All) 96 | Aliases: 97 | 98 | Required: False 99 | Position: Named 100 | Default value: False 101 | Accept pipeline input: False 102 | Accept wildcard characters: False 103 | ``` 104 | 105 | ### Common Parameters 106 | 107 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 108 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VMwareAriaSuiteOverview.md: -------------------------------------------------------------------------------- 1 | # Request-VMwareAriaSuiteOverview 2 | 3 | ## Synopsis 4 | 5 | Returns an overview of VMware Aria Suite products managed by SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VMwareAriaSuiteOverview [-server] [-user] [-pass] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VMwareAriaSuiteOverview` cmdlet returns an overview of VMware Aria Suite products managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication to the SDDC Manager instance. 19 | - Collects the VMware Aria Suite product overview detail. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-VMwareAriaSuiteOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return an overview of VMware Aria Suite products managed by the SDDC Manager instance. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-VMwareAriaSuiteOverview -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -anonymized 35 | ``` 36 | 37 | This example will return an overview of VMware Aria Suite products managed by the SDDC Manager instance, but will anonymize the output. 38 | 39 | ## Parameters 40 | 41 | ### -server 42 | 43 | The fully qualified domain name of the SDDC Manager. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -user 58 | 59 | The username to authenticate to the SDDC Manager. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: True 67 | Position: 2 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -pass 74 | 75 | The password to authenticate to the SDDC Manager. 76 | 77 | ```yaml 78 | Type: String 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: True 83 | Position: 3 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### -anonymized 90 | 91 | Switch to enable anonymized output for the report. 92 | 93 | ```yaml 94 | Type: SwitchParameter 95 | Parameter Sets: (All) 96 | Aliases: 97 | 98 | Required: False 99 | Position: Named 100 | Default value: False 101 | Accept pipeline input: False 102 | Accept wildcard characters: False 103 | ``` 104 | 105 | ### Common Parameters 106 | 107 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 108 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SddcManagerSnapshotStatus.md: -------------------------------------------------------------------------------- 1 | # Request-SddcManagerSnapshotStatus 2 | 3 | ## Synopsis 4 | 5 | Request the snapshot status for the SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SddcManagerSnapshotStatus [-server] [-user] [-pass] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SddcManagerSnapshotStatus` cmdlet checks the snapshot status for SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authenticaton to the SDDC Manager instance. 19 | - Gathers the details for the vCenter instance from the SDDC Manager. 20 | - Validates network connectivity and authentication to the vCenter instance. 21 | - Performs checks on the snapshot status and outputs the results. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-SddcManagerSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 29 | ``` 30 | 31 | This example will publish the snapshot status for the SDDC Manager in a VMware Cloud Foundation instance. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-SddcManagerSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -failureOnly 37 | ``` 38 | 39 | This example will publish the snapshot status for the SDDC Manager in a VMware Cloud Foundation instance but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -failureOnly 92 | 93 | Switch to only output issues to the report. 94 | 95 | ```yaml 96 | Type: SwitchParameter 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: False 101 | Position: Named 102 | Default value: False 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### Common Parameters 108 | 109 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 110 | -------------------------------------------------------------------------------- /docs/documentation/functions/Invoke-VcfUpgradePrecheck.md: -------------------------------------------------------------------------------- 1 | # Invoke-VcfUpgradePrecheck 2 | 3 | ## Synopsis 4 | 5 | Perform an upgrade precheck. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Invoke-VcfUpgradePrecheck [-sddcManagerFqdn] [-sddcManagerUser] [-sddcManagerPass] [-reportPath] [-workloadDomain] [-darkMode] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Invoke-VcfUpgradePrecheck` runs an upgrade precheck for a workload domain. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Invoke-VcfUpgradePrecheck -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -reportPath [report_path] -workloadDomain [workload_domain_name] 23 | ``` 24 | 25 | This example runs a health check for a specific workload domain within an SDDC Manager instance. 26 | 27 | ## Parameters 28 | 29 | ### -sddcManagerFqdn 30 | 31 | The fully qualified domain name of the SDDC Manager. 32 | 33 | ```yaml 34 | Type: String 35 | Parameter Sets: (All) 36 | Aliases: 37 | 38 | Required: True 39 | Position: Named 40 | Default value: None 41 | Accept pipeline input: False 42 | Accept wildcard characters: False 43 | ``` 44 | 45 | ### -sddcManagerUser 46 | 47 | The username to authenticate to the SDDC Manager. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: True 55 | Position: Named 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -sddcManagerPass 62 | 63 | The password to authenticate to the SDDC Manager. 64 | 65 | ```yaml 66 | Type: String 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: True 71 | Position: Named 72 | Default value: None 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -reportPath 78 | 79 | The path to save the policy report. 80 | 81 | ```yaml 82 | Type: String 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: True 87 | Position: Named 88 | Default value: None 89 | Accept pipeline input: False 90 | Accept wildcard characters: False 91 | ``` 92 | 93 | ### -workloadDomain 94 | 95 | The name of the workload domain to run against. 96 | 97 | ```yaml 98 | Type: String 99 | Parameter Sets: (All) 100 | Aliases: 101 | 102 | Required: True 103 | Position: Named 104 | Default value: None 105 | Accept pipeline input: False 106 | Accept wildcard characters: False 107 | ``` 108 | 109 | ### -darkMode 110 | 111 | Switch to enable dark mode for the report. 112 | 113 | ```yaml 114 | Type: SwitchParameter 115 | Parameter Sets: (All) 116 | Aliases: 117 | 118 | Required: False 119 | Position: Named 120 | Default value: False 121 | Accept pipeline input: False 122 | Accept wildcard characters: False 123 | ``` 124 | 125 | ### Common Parameters 126 | 127 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 128 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtAlert.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtAlert 2 | 3 | ## Synopsis 4 | 5 | Returns alarms from NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtAlert [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtAlert` cmdlet returns all alarms from NSX. 16 | The cmdlet connects to the NSX Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to NSX. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the details for NSX. 21 | - Collects the alerts. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return alarms of NSX managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return alarms of NSX managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VsanAlert.md: -------------------------------------------------------------------------------- 1 | # Request-VsanAlert 2 | 3 | ## Synopsis 4 | 5 | Returns vSAN health check alarms from a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VsanAlert [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VsanAlert` cmdlet returns vSAN health check alarms from vCenter managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the vCenter instance. 19 | - Validates the authentication to vCenter with credentials from SDDC Manager. 20 | - Collects the vSAN health check alarms from vCenter. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VsanAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example will return vSAN health check alarms of a vCenter managed by SDDC Manager for a specified workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-VsanAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 36 | ``` 37 | 38 | This example will return vSAN health check alarms of a vCenter managed by SDDC Manager for a workload domain but only reports issues. 39 | 40 | ## Parameters 41 | 42 | ### -server 43 | 44 | The fully qualified domain name of the SDDC Manager. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: True 52 | Position: 1 53 | Default value: None 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -user 59 | 60 | The username to authenticate to the SDDC Manager. 61 | 62 | ```yaml 63 | Type: String 64 | Parameter Sets: (All) 65 | Aliases: 66 | 67 | Required: True 68 | Position: 2 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -pass 75 | 76 | The password to authenticate to the SDDC Manager. 77 | 78 | ```yaml 79 | Type: String 80 | Parameter Sets: (All) 81 | Aliases: 82 | 83 | Required: True 84 | Position: 3 85 | Default value: None 86 | Accept pipeline input: False 87 | Accept wildcard characters: False 88 | ``` 89 | 90 | ### -domain 91 | 92 | The name of the workload domain to run against. 93 | 94 | ```yaml 95 | Type: String 96 | Parameter Sets: (All) 97 | Aliases: 98 | 99 | Required: True 100 | Position: 4 101 | Default value: None 102 | Accept pipeline input: False 103 | Accept wildcard characters: False 104 | ``` 105 | 106 | ### -failureOnly 107 | 108 | Switch to only output issues to the report. 109 | 110 | ```yaml 111 | Type: SwitchParameter 112 | Parameter Sets: (All) 113 | Aliases: 114 | 115 | Required: False 116 | Position: Named 117 | Default value: False 118 | Accept pipeline input: False 119 | Accept wildcard characters: False 120 | ``` 121 | 122 | ### Common Parameters 123 | 124 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 125 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-EsxiStorageCapacity.md: -------------------------------------------------------------------------------- 1 | # Request-EsxiStorageCapacity 2 | 3 | ## Synopsis 4 | 5 | Checks the disk usage for ESX hosts. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-EsxiStorageCapacity [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-EsxiStorageCapacity` cmdlets checks the disk space usage on ESX hosts. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Collects disk usage information for each ESX host in the workload domain. 20 | - Checks disk usage against thresholds and outputs the results. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-EsxiStorageCapacity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example will check disk usage for ESX hosts managed by SDDC Manager for a specified workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-EsxiStorageCapacity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 36 | ``` 37 | 38 | This example will check disk usage for ESX hosts managed by SDDC Manager for a specified workload domain but only reports issues. 39 | 40 | ## Parameters 41 | 42 | ### -server 43 | 44 | The fully qualified domain name of the SDDC Manager. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: True 52 | Position: 1 53 | Default value: None 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -user 59 | 60 | The username to authenticate to the SDDC Manager. 61 | 62 | ```yaml 63 | Type: String 64 | Parameter Sets: (All) 65 | Aliases: 66 | 67 | Required: True 68 | Position: 2 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -pass 75 | 76 | The password to authenticate to the SDDC Manager. 77 | 78 | ```yaml 79 | Type: String 80 | Parameter Sets: (All) 81 | Aliases: 82 | 83 | Required: True 84 | Position: 3 85 | Default value: None 86 | Accept pipeline input: False 87 | Accept wildcard characters: False 88 | ``` 89 | 90 | ### -domain 91 | 92 | The name of the workload domain to run against. 93 | 94 | ```yaml 95 | Type: String 96 | Parameter Sets: (All) 97 | Aliases: 98 | 99 | Required: True 100 | Position: 4 101 | Default value: None 102 | Accept pipeline input: False 103 | Accept wildcard characters: False 104 | ``` 105 | 106 | ### -failureOnly 107 | 108 | Switch to only output issues to the report. 109 | 110 | ```yaml 111 | Type: SwitchParameter 112 | Parameter Sets: (All) 113 | Aliases: 114 | 115 | Required: False 116 | Position: Named 117 | Default value: False 118 | Accept pipeline input: False 119 | Accept wildcard characters: False 120 | ``` 121 | 122 | ### Common Parameters 123 | 124 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 125 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-EsxiAlert.md: -------------------------------------------------------------------------------- 1 | # Request-EsxiAlert 2 | 3 | ## Synopsis 4 | 5 | Returns alarms from all ESX hosts in a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-EsxiAlert [-server] [-user] [-pass] [[-domain] ] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-EsxiAlert` cmdlet returns all alarms from all ESX hosts in vCenter managed by SDDC Manager. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the vCenter instance. 19 | - Validates the authentication to vCenter with credentials from SDDC Manager. 20 | - Collects the alerts from all ESX hosts in vCenter instance. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-EsxiAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-EsxiAlert -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 36 | ``` 37 | 38 | This example will return alarms from all ESX hosts in vCenter managed by SDDC Manager for a specified workload domain but only reports issues. 39 | 40 | ## Parameters 41 | 42 | ### -server 43 | 44 | The fully qualified domain name of the SDDC Manager. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: True 52 | Position: 1 53 | Default value: None 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -user 59 | 60 | The username to authenticate to the SDDC Manager. 61 | 62 | ```yaml 63 | Type: String 64 | Parameter Sets: (All) 65 | Aliases: 66 | 67 | Required: True 68 | Position: 2 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -pass 75 | 76 | The password to authenticate to the SDDC Manager. 77 | 78 | ```yaml 79 | Type: String 80 | Parameter Sets: (All) 81 | Aliases: 82 | 83 | Required: True 84 | Position: 3 85 | Default value: None 86 | Accept pipeline input: False 87 | Accept wildcard characters: False 88 | ``` 89 | 90 | ### -domain 91 | 92 | The name of the workload domain to run against. 93 | 94 | ```yaml 95 | Type: String 96 | Parameter Sets: (All) 97 | Aliases: 98 | 99 | Required: False 100 | Position: 4 101 | Default value: None 102 | Accept pipeline input: False 103 | Accept wildcard characters: False 104 | ``` 105 | 106 | ### -failureOnly 107 | 108 | Switch to only output issues to the report. 109 | 110 | ```yaml 111 | Type: SwitchParameter 112 | Parameter Sets: (All) 113 | Aliases: 114 | 115 | Required: False 116 | Position: Named 117 | Default value: False 118 | Accept pipeline input: False 119 | Accept wildcard characters: False 120 | ``` 121 | 122 | ### Common Parameters 123 | 124 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 125 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-EsxiConnectionHealth.md: -------------------------------------------------------------------------------- 1 | # Request-EsxiConnectionHealth 2 | 3 | ## Synopsis 4 | 5 | Returns the connection status of ESX hosts in a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-EsxiConnectionHealth [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-EsxiConnectionHealth` cmdlet returns the connection status of ESX hosts in a workload domain. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the connection status of ESX hosts in a workload domain. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-EsxiConnectionHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example returns the connection status of ESX hosts in a specified workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-EsxiConnectionHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 36 | ``` 37 | 38 | This example returns the connection status of ESX hosts in a specified workload domain but only reports issues. 39 | 40 | ## Parameters 41 | 42 | ### -server 43 | 44 | The fully qualified domain name of the SDDC Manager. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: True 52 | Position: 1 53 | Default value: None 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -user 59 | 60 | The username to authenticate to the SDDC Manager. 61 | 62 | ```yaml 63 | Type: String 64 | Parameter Sets: (All) 65 | Aliases: 66 | 67 | Required: True 68 | Position: 2 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -pass 75 | 76 | The password to authenticate to the SDDC Manager. 77 | 78 | ```yaml 79 | Type: String 80 | Parameter Sets: (All) 81 | Aliases: 82 | 83 | Required: True 84 | Position: 3 85 | Default value: None 86 | Accept pipeline input: False 87 | Accept wildcard characters: False 88 | ``` 89 | 90 | ### -domain 91 | 92 | The name of the workload domain to run against. 93 | 94 | ```yaml 95 | Type: String 96 | Parameter Sets: (All) 97 | Aliases: 98 | 99 | Required: True 100 | Position: 4 101 | Default value: None 102 | Accept pipeline input: False 103 | Accept wildcard characters: False 104 | ``` 105 | 106 | ### -failureOnly 107 | 108 | Switch to only output issues to the report. 109 | 110 | ```yaml 111 | Type: SwitchParameter 112 | Parameter Sets: (All) 113 | Aliases: 114 | 115 | Required: False 116 | Position: Named 117 | Default value: False 118 | Accept pipeline input: False 119 | Accept wildcard characters: False 120 | ``` 121 | 122 | ### Common Parameters 123 | 124 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 125 | -------------------------------------------------------------------------------- /docs/documentation/functions/Invoke-SddcCommand.md: -------------------------------------------------------------------------------- 1 | # Invoke-SddcCommand 2 | 3 | ## Synopsis 4 | 5 | Run a command on SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Invoke-SddcCommand [-server] [-user] [-pass] [-vmUser] [-vmPass] [-command] 11 | [] 12 | ``` 13 | 14 | ## Description 15 | 16 | The `Invoke-SddcCommand` cmdlet runs a command within the SDDC Manager appliance. 17 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 18 | 19 | - Validates that network connectivity is available to the SDDC Manager instance. 20 | - Validates that network connectivity is available to the Management Domain vCenter instance. 21 | - Runs the command provided within the SDDC Manager appliance. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Invoke-SddcCommand -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -vmUser [local_username] -vmPass [local_password] -command "chage -l backup" 29 | ``` 30 | 31 | This example runs the command provided on the SDDC Manager appliance with the user specified for the `-vmUser` parameter. 32 | 33 | ## Parameters 34 | 35 | ### -server 36 | 37 | The fully qualified domain name of the SDDC Manager. 38 | 39 | ```yaml 40 | Type: String 41 | Parameter Sets: (All) 42 | Aliases: 43 | 44 | Required: True 45 | Position: 1 46 | Default value: None 47 | Accept pipeline input: False 48 | Accept wildcard characters: False 49 | ``` 50 | 51 | ### -user 52 | 53 | The username to authenticate to the SDDC Manager. 54 | 55 | ```yaml 56 | Type: String 57 | Parameter Sets: (All) 58 | Aliases: 59 | 60 | Required: True 61 | Position: 2 62 | Default value: None 63 | Accept pipeline input: False 64 | Accept wildcard characters: False 65 | ``` 66 | 67 | ### -pass 68 | 69 | The password to authenticate to the SDDC Manager. 70 | 71 | ```yaml 72 | Type: String 73 | Parameter Sets: (All) 74 | Aliases: 75 | 76 | Required: True 77 | Position: 3 78 | Default value: None 79 | Accept pipeline input: False 80 | Accept wildcard characters: False 81 | ``` 82 | 83 | ### -vmUser 84 | 85 | The username to authenticate to the virtual machine. 86 | 87 | ```yaml 88 | Type: String 89 | Parameter Sets: (All) 90 | Aliases: 91 | 92 | Required: True 93 | Position: 4 94 | Default value: None 95 | Accept pipeline input: False 96 | Accept wildcard characters: False 97 | ``` 98 | 99 | ### -vmPass 100 | 101 | The password to authenticate to the virtual machine. 102 | 103 | ```yaml 104 | Type: String 105 | Parameter Sets: (All) 106 | Aliases: 107 | 108 | Required: True 109 | Position: 5 110 | Default value: None 111 | Accept pipeline input: False 112 | Accept wildcard characters: False 113 | ``` 114 | 115 | ### -command 116 | 117 | The command to run on the virtual machine. 118 | 119 | ```yaml 120 | Type: String 121 | Parameter Sets: (All) 122 | Aliases: 123 | 124 | Required: True 125 | Position: 6 126 | Default value: None 127 | Accept pipeline input: False 128 | Accept wildcard characters: False 129 | ``` 130 | 131 | ### Common Parameters 132 | 133 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 134 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterStorageHealth.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterStorageHealth 2 | 3 | ## Synopsis 4 | 5 | Checks the disk usage on a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterStorageHealth [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterStorageHealth` cmdlets checks the disk space usage on a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Validates network connectivity and authentication to the vCenter instance. 20 | - Collects information for the disk usage. 21 | - Checks disk usage against thresholds and outputs the results. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-VcenterStorageHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will check disk usage for a vCenter instance managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-VcenterStorageHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly 37 | ``` 38 | 39 | This example will check the disk usage for all vCenter instances managed by SDDC Manager but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtTransportNodeTunnelStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtTransportNodeTunnelStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of NSX transport node tunnels. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtTransportNodeTunnelStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtTransportNodeTunnelStatus` cmdlet returns the status of NSX transport nodes tunnels. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for NSX from the SDDC Manager. 20 | - Validates network connectivity and authentication to NSX. 21 | - Collects the status of the transport node tunnels. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtTransportNodeTunnelStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the status of the NSX transport node tunnels for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtTransportNodeTunnelStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the status of the NSX transport node tunnels for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-DatastoreStorageCapacity.md: -------------------------------------------------------------------------------- 1 | # Request-DatastoreStorageCapacity 2 | 3 | ## Synopsis 4 | 5 | Checks the datastore usage in all vCenter instances. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-DatastoreStorageCapacity [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-DatastoreStorageCapacity` cmdlet checks the datastore usage in all vCenters. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to the vCenter instance. 20 | - Gathers the details for each vCenter. 21 | - Collects information about datastore usage. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-DatastoreStorageCapacity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will check datastores on a vCenter managed by SDDC Manager in a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-DatastoreStorageCapacity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will check datastores on a vCenter managed by SDDC Manager in a VMware Cloud Foundation instance in a specified workload domain and will only report issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtVidmStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtVidmStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of the identity manager integration for NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtVidmStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtVidmStatus` cmdlet returns the status of the identity manager integration for NSX. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for NSX from the SDDC Manager. 20 | - Validates network connectivity and authentication to NSX. 21 | - Collects the identity manager integration status details. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtVidmStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the status of the identity manager integration for NSX managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtVidmStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the status of the identity manager integration for NSX managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtTier0BgpStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtTier0BgpStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the BGP status for all Tier-0 gateways managed by NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtTier0BgpStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtTier0BgpStatus` cmdlet returns the BGP status for all Tier-0 gateways managed by NSX. 16 | The cmdlet connects to NSX using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity is available to the SDDC Manager instance. 19 | - Validates that network connectivity is available to NSX. 20 | - Gathers the details for NSX. 21 | - Collects the BGP status for all Tier-0 gateways managed by NSX. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtTier0BgpStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the BGP status for all Tier-0 gateways managed by NSX which is managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtTier0BgpStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the BGP status for all Tier-0 gateways managed by NSX which is managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtManagerBackupStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtManagerBackupStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of the latest file-level backup of an NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtManagerBackupStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtManagerBackupStatus` cmdlet returns the status of the latest backup of an NSX instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for NSX from the SDDC Manager. 20 | - Validates network connectivity and authentication to NSX. 21 | - Collects the file-level backup status details. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtManagerBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the status of the latest file-level backup of NSX managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtManagerBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the status of the latest file-level backup of NSX managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtComputeManagerStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtComputeManagerStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of the compute managers attached to NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtComputeManagerStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtComputeManagerStatus` cmdlet returns the status of the compute managers attached to NSX. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for NSX from the SDDC Manager. 20 | - Validates network connectivity and authentication to NSX. 21 | - Collects the status of the compute managers. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtComputeManagerStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the status of the compute managers attached to NSX managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtComputeManagerStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the status of the compute managers attached to NSX managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtEdgeSnapshotStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtEdgeSnapshotStatus 2 | 3 | ## Synopsis 4 | 5 | Request the snapshot status for NSX edge nodes. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtEdgeSnapshotStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtEdgeSnapshotStatus` cmdlet checks the snapshot status for NSX edge nodes. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the NSX service and edge node details from the SDDC Manager. 20 | - Validates network connectivity and authentication to the vCenter instance. 21 | - Performs checks on the snapshot status and outputs the results. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtEdgeSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will publish the snapshot status for all NSX edge nodes managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtEdgeSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will publish the snapshot status for all NSX edge nodes managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterSnapshotStatus.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterSnapshotStatus 2 | 3 | ## Synopsis 4 | 5 | Request the snapshot status for the vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterSnapshotStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterSnapshotStatus` cmdlet checks the snapshot status for vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for the vCenter instance from the SDDC Manager. 20 | - Validates network connectivity and authentication to the vCenter instance. 21 | - Performs checks on the snapshot status and outputs the results. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-VcenterSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will publish the snapshot status for a vCenter instance managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-VcenterSnapshotStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will publish the snapshot status for a vCenter instance managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtTransportNodeStatus.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtTransportNodeStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of NSX transport nodes managed by NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtTransportNodeStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtTransportNodeStatus` cmdlet returns the status NSX transport nodes managed by NSX. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for NSX from the SDDC Manager. 20 | - Validates network connectivity and authentication to NSX. 21 | - Collects the status of the transport nodes. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-NsxtTransportNodeStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the status of the NSX transport nodes managed by NSX which is managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-NsxtTransportNodeStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the status of the NSX transport nodes managed by NSX which is managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /docs/documentation/functions/Invoke-VcfOverviewReport.md: -------------------------------------------------------------------------------- 1 | # Invoke-VcfOverviewReport 2 | 3 | ## Synopsis 4 | 5 | Generates the system overview report for a VMware Cloud Foundation instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Invoke-VcfOverviewReport [-sddcManagerFqdn] [-sddcManagerUser] [-sddcManagerPass] [-reportPath] [-darkMode] [-anonymized] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Invoke-VcfOverviewReport` provides a single cmdlet to generates a system overview report for a VMware Cloud Foundation instance. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Invoke-VcfOverviewReport -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -reportPath [report_path] 23 | ``` 24 | 25 | This example generates the system overview report for a VMware Cloud Foundation instance. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Invoke-VcfOverviewReport -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -reportPath [report_path] -anonymized 31 | ``` 32 | 33 | This example generates the system overview report for a VMware Cloud Foundation instance, but will anonymize the output. 34 | 35 | ## Parameters 36 | 37 | ### -sddcManagerFqdn 38 | 39 | The fully qualified domain name of the SDDC Manager. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: True 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### -sddcManagerUser 54 | 55 | The username to authenticate to the SDDC Manager. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: True 63 | Position: 2 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -sddcManagerPass 70 | 71 | The password to authenticate to the SDDC Manager. 72 | 73 | ```yaml 74 | Type: String 75 | Parameter Sets: (All) 76 | Aliases: 77 | 78 | Required: True 79 | Position: 3 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -reportPath 86 | 87 | The path to save the policy report. 88 | 89 | ```yaml 90 | Type: String 91 | Parameter Sets: (All) 92 | Aliases: 93 | 94 | Required: True 95 | Position: 4 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### -darkMode 102 | 103 | Switch to enable dark mode for the report. 104 | 105 | ```yaml 106 | Type: SwitchParameter 107 | Parameter Sets: (All) 108 | Aliases: 109 | 110 | Required: False 111 | Position: Named 112 | Default value: False 113 | Accept pipeline input: False 114 | Accept wildcard characters: False 115 | ``` 116 | 117 | ### -anonymized 118 | 119 | Switch to enable anonymized output for the report. 120 | 121 | ```yaml 122 | Type: SwitchParameter 123 | Parameter Sets: (All) 124 | Aliases: 125 | 126 | Required: False 127 | Position: Named 128 | Default value: False 129 | Accept pipeline input: False 130 | Accept wildcard characters: False 131 | ``` 132 | 133 | ### Common Parameters 134 | 135 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 136 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-SddcManagerFreePool.md: -------------------------------------------------------------------------------- 1 | # Publish-SddcManagerFreePool 2 | 3 | ## Synopsis 4 | 5 | Publish SDDC Manager free pool health information in HTML format. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Publish-SddcManagerFreePool [-server] [-user] [-pass] [-failureOnly] [-outputJson ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Publish-SddcManagerFreePool` cmdlet returns SDDC Manager free pool information in HTML format. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates the network connectivity and authentication to the SDDC Manager. 19 | - Publishes information. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Publish-SddcManagerFreePool -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 27 | ``` 28 | 29 | This example will return the free pool health from SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Publish-SddcManagerFreePool -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -failureOnly 35 | ``` 36 | 37 | This example will return the free pool health from SDDC Manager but only reports issues. 38 | 39 | ### Example 3 40 | 41 | ```powershell 42 | Publish-SddcManagerFreePool -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -outputJson [report_path] 43 | ``` 44 | 45 | This example will generate a json for the status the free pool health from SDDC Manager and saves it under the 46 | specified report path with filename `-sddc-manager-free-pool-status.json` 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 1 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 2 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 3 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -failureOnly 99 | 100 | Switch to only output issues to the report. 101 | 102 | ```yaml 103 | Type: SwitchParameter 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: False 108 | Position: Named 109 | Default value: False 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -outputJson 115 | 116 | The path to save the output as a JSON file. 117 | 118 | ```yaml 119 | Type: String 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: None 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### Common Parameters 131 | 132 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 133 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-VmOverride.md: -------------------------------------------------------------------------------- 1 | # Publish-VmOverride 2 | 3 | ## Synopsis 4 | 5 | Publish VM override information in HTML format. 6 | 7 | ## Syntax 8 | 9 | ### All-WorkloadDomains 10 | 11 | ```powershell 12 | Publish-VmOverride [-server] [-user] [-pass] [-allDomains] [] 13 | ``` 14 | 15 | ### Specific-WorkloadDomain 16 | 17 | ```powershell 18 | Publish-VmOverride [-server] [-user] [-pass] [-workloadDomain] [] 19 | ``` 20 | 21 | ## Description 22 | 23 | The `Publish-VmOverride` cmdlet returns VM override information in HTML format. 24 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 25 | 26 | - Validates that network connectivity is available to the vCenter instance. 27 | - Validates the authentication to vCenter with credentials from SDDC Manager. 28 | - Publishes information. 29 | 30 | ## Examples 31 | 32 | ### Example 1 33 | 34 | ```powershell 35 | Publish-VmOverride -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains 36 | ``` 37 | 38 | This example will return VM override details from all clusters in vCenter managed by SDDC Manager for all workload domains. 39 | 40 | ### Example 2 41 | 42 | ```powershell 43 | Publish-VmOverride -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] 44 | ``` 45 | 46 | This example will return VM override details from all clusters in vCenter managed by SDDC Manager for a specified workload domain. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -allDomains 99 | 100 | Switch to run health checks across all workload domains. 101 | 102 | ```yaml 103 | Type: SwitchParameter 104 | Parameter Sets: All-WorkloadDomains 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: False 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -workloadDomain 115 | 116 | The name of the workload domain to run against. 117 | 118 | ```yaml 119 | Type: String 120 | Parameter Sets: Specific-WorkloadDomain 121 | Aliases: 122 | 123 | Required: True 124 | Position: Named 125 | Default value: None 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### Common Parameters 131 | 132 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 133 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterBackupStatus.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterBackupStatus 2 | 3 | ## Synopsis 4 | 5 | Returns the status of the latest file-level backup of a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterBackupStatus [-server] [-user] [-pass] [-domain] [-failureOnly] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterBackupStatus` cmdlet returns the status of the latest file-level backup of a vCenter instance. 16 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates network connectivity and authentication to the SDDC Manager instance. 19 | - Gathers the details for the vCenter instance from the SDDC Manager. 20 | - Validates network connectivity and authentication to the vCenter instance. 21 | - Collects the file-level backup status details. 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-VcenterBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example will return the status of the latest file-level backup of a vCenter instance managed by SDDC Manager for a specified workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-VcenterBackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failureOnly 37 | ``` 38 | 39 | This example will return the status of the latest file-level backup of a vCenter instance managed by SDDC Manager for a specified workload domain but only reports issues. 40 | 41 | ## Parameters 42 | 43 | ### -server 44 | 45 | The fully qualified domain name of the SDDC Manager. 46 | 47 | ```yaml 48 | Type: String 49 | Parameter Sets: (All) 50 | Aliases: 51 | 52 | Required: True 53 | Position: 1 54 | Default value: None 55 | Accept pipeline input: False 56 | Accept wildcard characters: False 57 | ``` 58 | 59 | ### -user 60 | 61 | The username to authenticate to the SDDC Manager. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 2 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -pass 76 | 77 | The password to authenticate to the SDDC Manager. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 3 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -domain 92 | 93 | The name of the workload domain to run against. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 4 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -failureOnly 108 | 109 | Switch to only output issues to the report. 110 | 111 | ```yaml 112 | Type: SwitchParameter 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: Named 118 | Default value: False 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### Common Parameters 124 | 125 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 126 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | A PowerShell Module for Cloud Foundation Reporting

4 | 5 | # PowerShell Module for VMware Cloud Foundation Reporting 6 | 7 | [![Documentation](https://img.shields.io/badge/Read-documentation-blue?logo=readthedocs)][docs-module] 8 | [![PS Version](https://img.shields.io/powershellgallery/v/VMware.CloudFoundation.Reporting?label=Version)](https://www.powershellgallery.com/packages/VMware.CloudFoundation.Reporting) 9 | [![PS Downloads](https://img.shields.io/powershellgallery/dt/VMware.CloudFoundation.Reporting?label=Downloads)](https://www.powershellgallery.com/packages/VMware.CloudFoundation.Reporting) 10 | [![Changelog](https://img.shields.io/badge/Changelog-Read-blue)](CHANGELOG.md) 11 | [![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=success&label=Clone&query=count&url=https://gist.githubusercontent.com/nathanthaler/3c82845142447c9d2bdd38b0c573e33d/raw/clone.json&logo=github)](https://gist.githubusercontent.com/nathanthaler/3c82845142447c9d2bdd38b0c573e33d/raw/clone.json) 12 | 13 | ## Overview 14 | 15 | `VMware.CloudFoundation.Reporting` is a PowerShell module that has been written to support the ability to provide 16 | insight to the operational state of [VMware Cloud Foundation][docs-vmware-cloud-foundation] through the use of 17 | PowerShell cmdlets. These cmdlets provide quick access to information from the PowerShell console as well as the 18 | ability to publish pre-defined HTML reports. 19 | 20 | For details on specific VMware Cloud Foundation versions supported by this module, please refer to the [documentation][docs-module]. 21 | 22 | ## Documentation 23 | 24 | For detailed instructions on using this module, refer to the [documentation][docs-module]. 25 | 26 | ## Contributing 27 | 28 | We encourage community contributions! To get started, please refer to the [contribution guidelines][contributing]. 29 | 30 | ## Support 31 | 32 | This module is community-driven and maintained by the project contributors. It is not officially 33 | supported by Broadcom Support but thrives on collaboration and input from its users. 34 | 35 | Use the GitHub [issues][gh-issues] to report bugs or suggest features and enhancements. Issues are 36 | monitored by the maintainers and are prioritized based on criticality and community [reactions][gh-reactions]. 37 | 38 | Before filing an issue, please search the issues and use the reactions feature to add votes to 39 | matching issues. Please include as much information as you can. Details like these are incredibly 40 | useful in helping the us evaluate and prioritize any changes: 41 | 42 | - A reproducible test case or series of steps. 43 | - Any modifications you've made relevant to the bug. 44 | - Anything unusual about your environment or deployment. 45 | 46 | You can also start a discussion on the GitHub [discussions][gh-discussions] area to ask questions or 47 | share ideas. 48 | 49 | ## License 50 | 51 | © Broadcom. All Rights Reserved. 52 | 53 | The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 54 | 55 | This project is licensed under the [BSD 2-Clause License](LICENSE). 56 | 57 | [changelog]: CHANGELOG.md 58 | [contributing]: CONTRIBUTING.md 59 | [docs-vmware-cloud-foundation]: https://docs.vmware.com/en/VMware-Cloud-Foundation 60 | [docs-module]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-reporting 61 | [gh-discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/discussions 62 | [gh-issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/issues 63 | [gh-reactions]: https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ 64 | [psgallery-module]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.Reporting 65 | -------------------------------------------------------------------------------- /docs/documentation/functions/Publish-ClusterDrsRule.md: -------------------------------------------------------------------------------- 1 | # Publish-ClusterDrsRule 2 | 3 | ## Synopsis 4 | 5 | Publish cluster DRS rule information in HTML format. 6 | 7 | ## Syntax 8 | 9 | ### All-WorkloadDomains 10 | 11 | ```powershell 12 | Publish-ClusterDrsRule [-server] [-user] [-pass] [-allDomains] [] 13 | ``` 14 | 15 | ### Specific-WorkloadDomain 16 | 17 | ```powershell 18 | Publish-ClusterDrsRule [-server] [-user] [-pass] [-workloadDomain] [] 19 | ``` 20 | 21 | ## Description 22 | 23 | The `Publish-ClusterDrsRule` cmdlet returns cluster DRS rule information in HTML format. 24 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 25 | 26 | - Validates that network connectivity is available to the vCenter instance. 27 | - Validates the authentication to vCenter with credentials from SDDC Manager. 28 | - Publishes information. 29 | 30 | ## Examples 31 | 32 | ### Example 1 33 | 34 | ```powershell 35 | Publish-ClusterDrsRule -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains 36 | ``` 37 | 38 | This example will return cluster DRS rules from all clusters in vCenters managed by SDDC Manager for all workload domains. 39 | 40 | ### Example 2 41 | 42 | ```powershell 43 | Publish-ClusterDrsRule -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name] 44 | ``` 45 | 46 | This example will return cluster DRS rules from all clusters in vCenter managed by SDDC Manager for a specified workload domain. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -allDomains 99 | 100 | Switch to run health checks across all workload domains. 101 | 102 | ```yaml 103 | Type: SwitchParameter 104 | Parameter Sets: All-WorkloadDomains 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: False 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -workloadDomain 115 | 116 | The name of the workload domain to run against. 117 | 118 | ```yaml 119 | Type: String 120 | Parameter Sets: Specific-WorkloadDomain 121 | Aliases: 122 | 123 | Required: True 124 | Position: Named 125 | Default value: None 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### Common Parameters 131 | 132 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable.` For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). 133 | --------------------------------------------------------------------------------