├── .ci └── pester.tests.ps1 ├── .github ├── ISSUE_TEMPLATE │ ├── bug.yml │ ├── config.yml │ ├── docs.yml │ └── enhancement.yml ├── comment_template.md ├── dependabot.yml ├── icon-400px.png ├── icon-400px.svg ├── icon-85px.svg ├── labeler-pull-requests.yml ├── pull_request_template.md └── workflows │ ├── docs.yml │ ├── lock-threads.yml │ ├── pull-requests.yml │ ├── release.yml │ ├── stale.yml │ └── tests.yml ├── .gitignore ├── CHANGELOG.md ├── CODEOWNERS ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── NOTICE ├── PowerVCF.psd1 ├── PowerVCF.psm1 ├── README.md ├── docs ├── assets │ ├── images │ │ ├── icon-color.svg │ │ └── icon-white.svg │ └── stylesheets │ │ └── extra.css ├── community │ ├── code-of-conduct.md │ ├── contributing.md │ ├── index.md │ └── support.md ├── documentation │ ├── functions │ │ ├── aria-suite │ │ │ ├── aria-automation │ │ │ │ └── Get-VCFVra.md │ │ │ ├── aria-operations-logs │ │ │ │ ├── Get-VCFVrli.md │ │ │ │ ├── Get-VCFVrliConnection.md │ │ │ │ └── Set-VCFVrliConnection.md │ │ │ ├── aria-operations │ │ │ │ ├── Get-VCFVrops.md │ │ │ │ ├── Get-VCFVropsConnection.md │ │ │ │ └── Set-VCFVropsConnection.md │ │ │ ├── aria-suite-lifecycle │ │ │ │ ├── Get-VCFVrslcm.md │ │ │ │ ├── New-VCFVrslcm.md │ │ │ │ ├── Remove-VCFVrslcm.md │ │ │ │ └── Reset-VCFVrslcm.md │ │ │ └── workspace-one-access │ │ │ │ └── Get-VCFWsa.md │ │ ├── authentication │ │ │ ├── Connect-CloudBuilder.md │ │ │ └── Request-VCFToken.md │ │ ├── avns │ │ │ ├── Add-VCFApplicationVirtualNetwork.md │ │ │ └── Get-VCFApplicationVirtualNetwork.md │ │ ├── backup-restore │ │ │ ├── Get-VCFBackupConfiguration.md │ │ │ ├── Get-VCFRestoreTask.md │ │ │ ├── Set-VCFBackupConfiguration.md │ │ │ ├── Start-VCFBackup.md │ │ │ └── Start-VCFRestore.md │ │ ├── bundles │ │ │ ├── Get-VCFBundle.md │ │ │ ├── Request-VCFBundle.md │ │ │ └── Start-VCFBundleUpload.md │ │ ├── ceip │ │ │ ├── Get-VCFCeip.md │ │ │ └── Set-VCFCeip.md │ │ ├── certificates │ │ │ ├── Get-VCFCertificate.md │ │ │ ├── Get-VCFCertificateAuthority.md │ │ │ ├── Get-VCFCertificateCsr.md │ │ │ ├── Remove-VCFCertificateAuthority.md │ │ │ ├── Request-VCFCertificate.md │ │ │ ├── Request-VCFCertificateCsr.md │ │ │ ├── Set-VCFCertificate.md │ │ │ ├── Set-VCFMicrosoftCa.md │ │ │ └── Set-VCFOpensslCa.md │ │ ├── clusters │ │ │ ├── Get-VCFCluster.md │ │ │ ├── Get-VCFClusterValidation.md │ │ │ ├── New-VCFCluster.md │ │ │ ├── Remove-VCFCluster.md │ │ │ └── Set-VCFCluster.md │ │ ├── compliance │ │ │ ├── Get-VCFCompliance.md │ │ │ ├── Get-VCFComplianceConfiguration.md │ │ │ ├── Get-VCFComplianceHistory.md │ │ │ ├── Get-VCFComplianceStandard.md │ │ │ ├── Get-VCFComplianceTask.md │ │ │ └── New-VCFCompliance.md │ │ ├── credentials │ │ │ ├── Get-VCFCredential.md │ │ │ ├── Get-VCFCredentialExpiry.md │ │ │ ├── Get-VCFCredentialTask.md │ │ │ ├── Restart-VCFCredentialTask.md │ │ │ ├── Set-VCFCredential.md │ │ │ ├── Set-VCFCredentialAutoRotatePolicy.md │ │ │ └── Stop-VCFCredentialTask.md │ │ ├── depots │ │ │ ├── Get-VCFDepotCredential.md │ │ │ └── Set-VCFDepotCredential.md │ │ ├── dns-ntp │ │ │ ├── Get-VCFConfigurationDNS.md │ │ │ ├── Get-VCFConfigurationDNSValidation.md │ │ │ ├── Get-VCFConfigurationNTP.md │ │ │ ├── Get-VCFConfigurationNTPValidation.md │ │ │ ├── Set-VCFConfigurationDNS.md │ │ │ └── Set-VCFConfigurationNTP.md │ │ ├── domains │ │ │ ├── Get-VCFWorkloadDomain.md │ │ │ ├── New-VCFWorkloadDomain.md │ │ │ ├── Remove-VCFWorkloadDomain.md │ │ │ └── Set-VCFWorkloadDomain.md │ │ ├── federation │ │ │ ├── Get-VCFFederation.md │ │ │ ├── Get-VCFFederationMember.md │ │ │ ├── Get-VCFFederationTask.md │ │ │ ├── Join-VCFFederation.md │ │ │ ├── New-VCFFederationInvite.md │ │ │ ├── Remove-VCFFederation.md │ │ │ └── Set-VCFFederation.md │ │ ├── fips │ │ │ └── Get-VCFFipsMode.md │ │ ├── hosts │ │ │ ├── Get-VCFHost.md │ │ │ ├── New-VCFCommissionedHost.md │ │ │ └── Remove-VCFCommissionedHost.md │ │ ├── iam │ │ │ ├── Get-VCFRole.md │ │ │ ├── Get-VCFUser.md │ │ │ ├── New-VCFGroup.md │ │ │ ├── New-VCFServiceUser.md │ │ │ ├── New-VCFUser.md │ │ │ └── Remove-VCFUser.md │ │ ├── idp │ │ │ ├── Get-VCFIdentityProvider.md │ │ │ ├── New-VCFIdentityProvider.md │ │ │ ├── Remove-VCFIdentityProvider.md │ │ │ └── Update-VCFIdentityProvider.md │ │ ├── json-export │ │ │ └── Export-VCFManagementDomainJsonSpec.md │ │ ├── licenses │ │ │ ├── Get-VCFLicenseKey.md │ │ │ ├── Get-VCFLicenseMode.md │ │ │ ├── New-VCFLicenseKey.md │ │ │ └── Remove-VCFLicenseKey.md │ │ ├── network-pools │ │ │ ├── Add-VCFNetworkIPPool.md │ │ │ ├── Get-VCFNetworkIPPool.md │ │ │ ├── Get-VCFNetworkPool.md │ │ │ ├── New-VCFNetworkPool.md │ │ │ ├── Remove-VCFNetworkIPPool.md │ │ │ └── Remove-VCFNetworkPool.md │ │ ├── nsx │ │ │ ├── nsx-edge-clusters │ │ │ │ ├── Get-VCFEdgeCluster.md │ │ │ │ └── New-VCFEdgeCluster.md │ │ │ └── nsx-managers │ │ │ │ └── Get-VCFNsxtCluster.md │ │ ├── other │ │ │ └── Invoke-VCFCommand.md │ │ ├── personalities │ │ │ ├── Get-VCFPersonality.md │ │ │ └── New-VCFPersonality.md │ │ ├── proxy │ │ │ ├── Get-VCFProxy.md │ │ │ └── Set-VCFProxy.md │ │ ├── pscs │ │ │ └── Get-VCFPSC.md │ │ ├── releases │ │ │ └── Get-VCFRelease.md │ │ ├── sddc-managers │ │ │ └── Get-VCFManager.md │ │ ├── sddc │ │ │ ├── Get-CloudBuilderSDDC.md │ │ │ ├── Get-CloudBuilderSDDCValidation.md │ │ │ ├── Restart-CloudBuilderSDDC.md │ │ │ ├── Restart-CloudBuilderSDDCValidation.md │ │ │ ├── Start-CloudBuilderSDDC.md │ │ │ ├── Start-CloudBuilderSDDCValidation.md │ │ │ └── Stop-CloudBuilderSDDCValidation.md │ │ ├── services │ │ │ └── Get-VCFService.md │ │ ├── sos │ │ │ ├── Get-VCFHealthSummaryTask.md │ │ │ ├── Get-VCFSupportBundleTask.md │ │ │ ├── Request-VCFHealthSummaryBundle.md │ │ │ ├── Request-VCFSupportBundle.md │ │ │ ├── Start-VCFHealthSummary.md │ │ │ └── Start-VCFSupportBundle.md │ │ ├── system-prechecks │ │ │ ├── Get-VCFSystemPrecheckTask.md │ │ │ └── Start-VCFSystemPrecheck.md │ │ ├── tasks │ │ │ ├── Get-VCFTask.md │ │ │ └── Restart-VCFTask.md │ │ ├── upgrades │ │ │ ├── Get-VCFUpgradable.md │ │ │ ├── Get-VCFUpgrade.md │ │ │ └── Start-VCFUpgrade.md │ │ └── vcenters │ │ │ └── Get-VCFvCenter.md │ ├── getting-started │ │ ├── install.md │ │ ├── update.md │ │ ├── usage.md │ │ └── user-access.md │ └── index.md ├── favicon.ico ├── index.md ├── license.md ├── release-notes.md ├── requirements.txt └── snippets │ ├── copy-module-local-linux.sh │ ├── copy-module-local-windows.ps1 │ ├── import-module-local-linux.ps1 │ ├── import-module.ps1 │ ├── install-module.ps1 │ ├── installed-module.ps1 │ ├── pre-req-linux.sh │ ├── save-module-local-linux.ps1 │ ├── save-module-local-windows.ps1 │ └── update-module.ps1 ├── mkdocs.yml └── samples ├── aria-suite └── aria-lifecycle │ ├── deployAriaLifecycleAvnOverlaySpec.json │ └── deployAriaLifecycleAvnVlanSpec.json ├── avns ├── avnOverlaySpec.json └── avnVlanSpec.json ├── backup-restore └── backupSpec.json ├── bundles └── bundleUploadSpec.json ├── certificates ├── requestCertificateSpec.json ├── requestCsrSpec.json └── updateCertificateSpec.json ├── clusters ├── clusterCompactionSpec.json └── clusterExpansionSpec.json ├── credentials ├── rotateCredentialSpec.json └── updateCredentialSpec.json ├── dns-ntp ├── dnsSpec.json └── ntpSpec.json ├── domains ├── domainSpec.json └── isolatedDomainSpec.json ├── federation ├── federationSpec.json └── joinFederationSpec.json ├── hosts ├── commissionHostsSpec.json ├── decommissionHostsSpec.json └── ui-commissionHostsSpec.json ├── idp ├── embeddedIdpSpec.json └── externalIdpSpec.json ├── network-pools └── networkPoolSpec.json ├── nsx └── nsx-edge-clusters │ └── edgeClusterSpec.json ├── proxy └── proxySpec.json ├── sddc ├── multiPnicSddcSpec.json └── sddcSpec.json ├── sos ├── healthSummarySpec.json └── supportBundleSpec.json ├── system-prechecks └── precheckSpec.json └── upgrades └── upgradeDomainSpec.json /.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 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | blank_issues_enabled: false 3 | contact_links: 4 | - name: Module Documentation 5 | url: 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation' 6 | about: Having trouble with the module? Check out the documentation. 7 | - name: VMware Cloud Foundation Documentation 8 | url: 'https://docs.vmware.com/en/VMware-Cloud-Foundation/' 9 | about: Having trouble with VMware Cloud Foundation? Check out the product documentation. 10 | -------------------------------------------------------------------------------- /.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] 18 | (https://github.com/PowerVCF/PowerVCF/blob/master/CODE_OF_CONDUCT.md) 19 | that all participants are expected to understand and follow. 20 | options: 21 | - label: I have read and agree to the project's Code of Conduct. 22 | required: true 23 | - type: input 24 | id: version-powervcf 25 | attributes: 26 | label: PowerVCF 27 | description: Please provide the PowerVCF version. 28 | validations: 29 | required: true 30 | - type: textarea 31 | id: motivation 32 | attributes: 33 | label: Motivation 34 | description: Why should we update our docs or examples? 35 | validations: 36 | required: false 37 | - type: textarea 38 | id: suggestion 39 | attributes: 40 | label: Suggestion 41 | description: What should we do instead? 42 | validations: 43 | required: false 44 | - type: markdown 45 | attributes: 46 | 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" 47 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/enhancement.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Enhancement Request 3 | description: Is something critical missing? Suggest a feature or 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 a feature, please search the existing issues and relevant feature requests. 12 | Use the reactions to add up-votes to existing requests. 13 | 14 | When filing a feature, please include the following information. 15 | - type: checkboxes 16 | id: terms 17 | attributes: 18 | label: Code of Conduct 19 | description: >- 20 | This project has a [Code of Conduct] 21 | (https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/blob/main/CODE_OF_CONDUCT.md) 22 | that all participants are expected to understand and follow. 23 | options: 24 | - label: I have read and agree to the project's Code of Conduct. 25 | required: true 26 | - type: textarea 27 | id: description 28 | attributes: 29 | label: Description 30 | description: A written overview of the feature. 31 | validations: 32 | required: true 33 | - type: textarea 34 | id: use-case 35 | attributes: 36 | label: Use Case(s) 37 | description: Any relevant use-cases that you see. 38 | validations: 39 | required: true 40 | - type: textarea 41 | id: potential-configuration 42 | attributes: 43 | label: Potential Configuration 44 | description: Provide a potential configuration. 45 | validations: 46 | required: true 47 | - type: textarea 48 | id: references 49 | attributes: 50 | label: References 51 | description: Provide any references. 52 | validations: 53 | required: false 54 | - type: markdown 55 | attributes: 56 | 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" 57 | -------------------------------------------------------------------------------- /.github/comment_template.md: -------------------------------------------------------------------------------- 1 | Hello,   {{ .author }} ! 🖐 2 | 3 | Thank you for your submitting an issue for the project. We will respond soon. 4 | 5 | If you want to contribute to this project, please review the contributing [guidelines](https://github.com/PowerVCF/PowerVCF/blob/master/CONTRIBUTING.md). -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | -------------------------------------------------------------------------------- /.github/icon-400px.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation/cd24a1123537c5bbb645955c2fce31b3a9425405/.github/icon-400px.png -------------------------------------------------------------------------------- /.github/icon-400px.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.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/docs.yml: -------------------------------------------------------------------------------- 1 | name: Publish Documentation 2 | on: 3 | workflow_dispatch: 4 | permissions: 5 | contents: write 6 | jobs: 7 | publish-docs: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout Repository 11 | uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 12 | with: 13 | fetch-depth: 0 14 | - name: Setup Python 15 | uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 16 | with: 17 | python-version: 3.x 18 | - name: Install Dependencies 19 | run: | 20 | pip install mkdocs-material 21 | pip install --requirement docs/requirements.txt 22 | - name: Publish Documentation 23 | run: | 24 | mkdocs gh-deploy --force 25 | if: ${{ success() }} 26 | -------------------------------------------------------------------------------- /.github/workflows/lock-threads.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Lock Threads 3 | 'on': 4 | schedule: 5 | - cron: 30 00 * * * 6 | jobs: 7 | lock: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: dessant/lock-threads@d42e5f49803f3c4e14ffee0378e31481265dda22 # v5.0.0 11 | with: 12 | github-token: '${{ github.token }}' 13 | issue-comment: > 14 | 'I'm going to lock this issue because it has been closed for 30 15 | days. This helps our maintainers find and focus on the active 16 | issues. 17 | 18 | If you have found a problem that seems similar to this, 19 | please open a new issue and complete the issue template so we can 20 | capture all the details necessary to investigate further.' 21 | issue-inactive-days: '30' 22 | pr-comment: > 23 | 'I'm going to lock this pull request because it has been closed for 24 | 30 days. This helps our maintainers find and focus on the active 25 | issues. 26 | 27 | If you have found a problem that seems related to this 28 | change, please open a new issue and complete the issue template so 29 | we can capture all the details necessary to investigate further.' 30 | pr-inactive-days: '30' 31 | -------------------------------------------------------------------------------- /.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 | jobs: 16 | labeler: 17 | name: Labeler 18 | runs-on: ubuntu-latest 19 | permissions: 20 | contents: read 21 | pull-requests: write 22 | steps: 23 | - name: Apply Labels 24 | uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0 25 | with: 26 | configuration-path: .github/labeler-pull-requests.yml 27 | repo-token: '${{ secrets.GITHUB_TOKEN }}' 28 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Manage Stale Items 3 | 'on': 4 | schedule: 5 | - cron: 00 00 * * * 6 | jobs: 7 | stale: 8 | runs-on: ubuntu-latest 9 | permissions: 10 | issues: write 11 | pull-requests: write 12 | steps: 13 | - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0 14 | with: 15 | repo-token: '${{ secrets.GITHUB_TOKEN }}' 16 | days-before-stale: 60 17 | days-before-close: 30 18 | exempt-issue-labels: 'needs-triage' 19 | exempt-pr-labels: 'needs-review' 20 | remove-stale-when-updated: true 21 | delete-branch: false 22 | stale-issue-label: stale 23 | stale-issue-message: > 24 | 'Marking this issue as stale due to inactivity. This helps us focus 25 | on the active issues. If this issue receives no comments in the next 26 | 30 days it will automatically be closed. 27 | 28 | 29 | If this issue was automatically closed and you feel this issue 30 | should be reopened, we encourage creating a new issue linking back 31 | to this one for added context. 32 | 33 | Thank you!' 34 | stale-pr-label: stale 35 | stale-pr-message: > 36 | 'Marking this pull request as stale due to inactivity. This helps us 37 | focus on the active pull requests. If this pull request receives no 38 | comments in the next 30 days it will automatically be closed. 39 | 40 | If this pull request was automatically closed and you feel this pull 41 | request should be reopened, we encourage creating a new pull request 42 | linking back to this one for added context. 43 | 44 | Thank you!' 45 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # MacOS 2 | ## Ignore desktop services files. 3 | **/.DS_Store 4 | 5 | # MkDocs 6 | ## Ignore site directory. 7 | **/.site/** 8 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | @vmware/powershell-module-for-vmware-cloud-foundation-maintainers 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 2-Clause License 2 | 3 | Copyright 2023-2024 Broadcom. All Rights Reserved. 4 | 5 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 6 | following conditions are met: 7 | 8 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following 9 | disclaimer. 10 | 11 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 12 | disclaimer in the documentation and/or other materials provided with the distribution. 13 | 14 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 15 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 16 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 17 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 18 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 19 | WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 20 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 21 | -------------------------------------------------------------------------------- /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 | PowerShell Module for VMware Cloud Foundation 2 | Copyright 2023-2024 Broadcom. All Rights Reserved. 3 | 4 | This product is licensed to you under the BSD-2 license (the "License"). You may not use this product except in 5 | compliance with the BSD-2 License. 6 | 7 | This product may include a number of subcomponents with separate copyright notices and license terms. Your use of 8 | these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file. 9 | -------------------------------------------------------------------------------- /docs/assets/images/icon-color.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/assets/images/icon-white.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 8 | 11 | 14 | 19 | 23 | 24 | -------------------------------------------------------------------------------- /docs/assets/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | .green { 2 | color: green; 3 | } 4 | .red { 5 | color: red; 6 | } 7 | -------------------------------------------------------------------------------- /docs/community/code-of-conduct.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CODE_OF_CONDUCT.md" 2 | -------------------------------------------------------------------------------- /docs/community/contributing.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CONTRIBUTING.md" 2 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /docs/community/support.md: -------------------------------------------------------------------------------- 1 | # Support 2 | 3 | :octicons-heart-24:   While this module is not supported by VMware Support Services, it is supported by the project maintainers and its community of users. 4 | 5 | :octicons-issue-opened-24:   Use the GitHub [issues][issues] to report bugs or suggest enhancements. 6 | 7 | :octicons-thumbsup-24:   Issues are monitored by the maintainers and are prioritized based on criticality and community [reactions][reactions]. 8 | 9 | :octicons-search-24:   Before opening an issue, please [search the issues][issues-search] and use the reactions to add votes to matching issues. Please include as much information as you can. Details like these are incredibly useful in helping the us evaluate and prioritize any changes: 10 | 11 | - A reproducible test case or series of steps. 12 | - Any modifications you've made relevant to the bug. 13 | - Anything unusual about your environment or deployment. 14 | 15 | :octicons-comment-discussion-24:   You can also start a discussion on the GitHub [discussions][discussions] area to ask questions or share ideas. 16 | 17 | [discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/discussions 18 | [issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/issues 19 | [issues-search]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/issues?q=is%3Aissue+is%3Aopen+label%3Abug 20 | [reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ 21 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-automation/Get-VCFVra.md: -------------------------------------------------------------------------------- 1 | # Get-VCFVra 2 | 3 | ## Alias 4 | 5 | `Get-VCFAriaAutomation` 6 | 7 | ## Synopsis 8 | 9 | Retrieves information about an Aria Automation deployment in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFVra 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFVra` cmdlet retrieves information about an Aria Automation deployment in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFVra 27 | ``` 28 | 29 | This example shows how to retrieve information about an Aria Automation deployment in VMware Cloud Foundation mode. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-operations-logs/Get-VCFVrli.md: -------------------------------------------------------------------------------- 1 | # Get-VCFVrli 2 | 3 | ## Alias 4 | 5 | `Get-VCFAriaOperationsLogs` 6 | 7 | ## Synopsis 8 | 9 | Retrieves information about Aria Operations for Logs deployment in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFVrli 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFVrli` cmdlet retrieves information about Aria Operations for Logs deployment in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFVrli 27 | ``` 28 | 29 | This example shows how to retrieve information about Aria Operations for Logs deployment in VMware Cloud Foundation mode. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-operations-logs/Get-VCFVrliConnection.md: -------------------------------------------------------------------------------- 1 | # Get-VCFVrliConnection 2 | 3 | ## Alias 4 | 5 | `Get-VCFAriaOperationsLogsConnection` 6 | 7 | ## Synopsis 8 | 9 | Retrieves the connection status for all workload domain connections to Aria Operations for Logs. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFVrliConnection 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFVrliConnection` cmdlet retrieves the connection status for all workload domain connections to Aria Operations for Logs. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFVrliConnection 27 | ``` 28 | 29 | This example shows how to retrieve the connection status for all workload domain connections to Aria Operations for Logs. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md: -------------------------------------------------------------------------------- 1 | # Set-VCFVrliConnection 2 | 3 | ## Alias 4 | 5 | `Set-VCFAriaOperationsLogsConnection` 6 | 7 | ## Synopsis 8 | 9 | Connects or disconnects workload domains to Aria Operations for Logs. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Set-VCFVrliConnection [-domainId] [-status] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Set-VCFVrliConnection` cmdlet connects or disconnects workload domains to Aria Operations for Logs. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Set-VCFVrli -domainId 44d23b12-76b6-4453-95f6-1dcaa837081f -status ENABLED 27 | ``` 28 | 29 | This example shows how to connect a workload domain to Aria Operations for Logs. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Set-VCFVrli -domainId 44d23b12-76b6-4453-95f6-1dcaa837081f -status DISABLED 35 | ``` 36 | 37 | This example shows how to disconnect a workload domain from Aria Operations for Logs. 38 | 39 | ## Parameters 40 | 41 | ### -domainId 42 | 43 | Specifies the unique ID of the workload domain. 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 | ### -status 58 | 59 | Specifies the status. One of: ENABLED, DISABLED. 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 | ### Common Parameters 74 | 75 | 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). 76 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-operations/Get-VCFVrops.md: -------------------------------------------------------------------------------- 1 | # Get-VCFVrops 2 | 3 | ## Alias 4 | 5 | `Get-VCFAriaOperations` 6 | 7 | ## Synopsis 8 | 9 | Retrieves information about Aria Operations deployment in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFVrops [-domains] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFVrops` cmdlet retrieves information about Aria Operations deployment in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFVrops 27 | ``` 28 | 29 | This example shows how to retrieve information about Aria Operations deployment in VMware Cloud Foundation mode. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Get-VCFVrops -domains 35 | ``` 36 | 37 | This example shows how to retrieve information workload domains connected to Aria Operations. 38 | 39 | ## Parameters 40 | 41 | ### -domains 42 | 43 | Specifies to list the connected workload domains. 44 | 45 | ```yaml 46 | Type: SwitchParameter 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: False 51 | Position: Named 52 | Default value: False 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### Common Parameters 58 | 59 | 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). 60 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-operations/Get-VCFVropsConnection.md: -------------------------------------------------------------------------------- 1 | # Get-VCFVropsConnection 2 | 3 | ## Alias 4 | 5 | `Get-VCFAriaOperationsConnection` 6 | 7 | ## Synopsis 8 | 9 | Retrieves the connection status for all workload domain connected to an Aria Operations deployment in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFVropsConnection 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFVropsConnection` cmdlet retrieves the connection status for all workload domain connected to an Aria Operations deployment in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFVropsConnection 27 | ``` 28 | 29 | This example shows how to retrieve the connection status for all workload domain connected to a Aria Operations deployment in VMware Cloud Foundation mode. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-operations/Set-VCFVropsConnection.md: -------------------------------------------------------------------------------- 1 | # Set-VCFVropsConnection 2 | 3 | ## Alias 4 | 5 | `Set-VCFAriaOperationsConnection` 6 | 7 | ## Synopsis 8 | 9 | Connects or disconnects workload domains to Aria Operations. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Set-VCFVropsConnection [-domainId] [-status] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Set-VCFVrops` cmdlet connects or disconnects workload domains to Aria Operations. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Set-VCFVrops -domainId 44d23b12-76b6-4453-95f6-1dcaa837081f -status ENABLED 27 | ``` 28 | 29 | This example shows how to connect a workload domain to Aria Operations. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Set-VCFVrops -domainId 44d23b12-76b6-4453-95f6-1dcaa837081f -status DISABLED 35 | ``` 36 | 37 | This example shows how to disconnect a workload domain from Aria Operations. 38 | 39 | ## Parameters 40 | 41 | ### -domainId 42 | 43 | Specifies the unique ID of the workload domain. 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 | ### -status 58 | 59 | Specifies the status. One of: ENABLED, DISABLED. 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 | ### Common Parameters 74 | 75 | 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). 76 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-VCFVrslcm.md: -------------------------------------------------------------------------------- 1 | # Get-VCFVrslcm 2 | 3 | ## Alias 4 | 5 | `Get-VCFAriaSuiteLifecycle` 6 | 7 | ## Synopsis 8 | 9 | Retrieves information about Aria Suite Lifecycle deployment in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFVrslcm 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFVrslcm` cmdlet retrieves information about Aria Suite Lifecycke deployment in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFVrslcm 27 | ``` 28 | 29 | This example shows how to retrieve information about Aria Suite Lifecycle deployment in VMware Cloud Foundation mode. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-suite-lifecycle/New-VCFVrslcm.md: -------------------------------------------------------------------------------- 1 | # New-VCFVrslcm 2 | 3 | ## Alias 4 | 5 | `New-VCFAriaSuiteLifecycle` 6 | 7 | ## Synopsis 8 | 9 | Deploys Aria Suite Lifecycle in the management domain in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | New-VCFVrslcm [-json] [-validate] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `New-VCFVrslcm` cmdlet deploys Aria Suite Lifecycle in the management domain in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | New-VCFVrslcm -json (Get-Content -Raw .\samples\aria-suite\aria-lifecycle\deployAriaLifecycleAvnOverlaySpec.json) 27 | ``` 28 | 29 | This example shows how to deploy Aria Suite Lifecycle using a JSON specification file. 30 | 31 | ???+ example "Sample JSON: Deploy Aria Suite Lifecycle" 32 | 33 | ```json 34 | --8<-- "./samples/aria-suite/aria-lifecycle/deployAriaLifecycleAvnOverlaySpec.json" 35 | ``` 36 | 37 | ### Example 2 38 | 39 | ```powershell 40 | New-VCFVrslcm -json (Get-Content -Raw .\samples\aria-suite\aria-lifecycle\deployAriaLifecycleAvnOverlaySpec.json) -validate 41 | ``` 42 | 43 | This example shows how to validate a JSON specification file. 44 | 45 | ## Parameters 46 | 47 | ### -json 48 | 49 | Specifies the JSON specification to be used. 50 | 51 | ```yaml 52 | Type: String 53 | Parameter Sets: (All) 54 | Aliases: 55 | 56 | Required: True 57 | Position: 1 58 | Default value: None 59 | Accept pipeline input: False 60 | Accept wildcard characters: False 61 | ``` 62 | 63 | ### -validate 64 | 65 | Specifies to validate the JSON specification file. 66 | 67 | ```yaml 68 | Type: SwitchParameter 69 | Parameter Sets: (All) 70 | Aliases: 71 | 72 | Required: False 73 | Position: Named 74 | Default value: False 75 | Accept pipeline input: False 76 | Accept wildcard characters: False 77 | ``` 78 | 79 | ### Common Parameters 80 | 81 | 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). 82 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-suite-lifecycle/Remove-VCFVrslcm.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFVrslcm 2 | 3 | ## Alias 4 | 5 | `Remove-VCFAriaSuiteLifecycle` 6 | 7 | ## Synopsis 8 | 9 | Removes a failed Aria Suite Lifecycle deployment. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Remove-VCFVrslcm 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Remove-VCFVrslcm` cmdlet removes a failed Aria Suite Lifecycle deployment in VMware Cloud Foundation mode. 20 | 21 | ???+ note 22 | 23 | This cmdlet is not applicable to a successful Aria Suite Lifecycle deployment. 24 | 25 | ## Examples 26 | 27 | ### Example 1 28 | 29 | ```powershell 30 | Remove-VCFVrslcm 31 | ``` 32 | 33 | This example shows how to remove a failed Aria Suite Lifecycle deployment. 34 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/aria-suite-lifecycle/Reset-VCFVrslcm.md: -------------------------------------------------------------------------------- 1 | # Reset-VCFVrslcm 2 | 3 | ## Alias 4 | 5 | `Reset-VCFAriaSuiteLifecycle` 6 | 7 | ## Synopsis 8 | 9 | Redeploys Aria Suite Lifecycle in the management domain in VMware Cloud Foundation mode. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Reset-VCFVrslcm 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Reset-VCFVrslcm` cmdlet redeploys Aria Suite Lifecycle in the management domain in VMware Cloud Foundation mode. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Reset-VCFVrslcm 27 | ``` 28 | 29 | This example shows how to redeploy Aria Suite Lifecycle in the management domain in VMware Cloud Foundation mode. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/aria-suite/workspace-one-access/Get-VCFWsa.md: -------------------------------------------------------------------------------- 1 | # Get-VCFWsa 2 | 3 | ## Synopsis 4 | 5 | Retrieves information about Workspace ONE Access deployment in VMware Cloud Foundation mode. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFWsa 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFWsa` cmdlet retrieves information about Workspace ONE Access deployment in VMware Cloud Foundation mode. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFWsa 23 | ``` 24 | 25 | This example shows how to retrieve information about Workspace ONE Access deployment in VMware Cloud Foundation mode. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md: -------------------------------------------------------------------------------- 1 | # Add-VCFApplicationVirtualNetwork 2 | 3 | ## Synopsis 4 | 5 | Creates Application Virtual Networks (AVN) in SDDC Manager and NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Add-VCFApplicationVirtualNetwork [-json] [-validate] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Add-VCFApplicationVirtualNetwork` cmdlet creates Application Virtual Networks in SDDC Manager and NSX. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Add-VCFApplicationVirtualNetwork -json (Get-Content -Raw .\samples\avns\avnOPverlaySpec.json) 23 | ``` 24 | 25 | This example shows how to deploy the Application Virtual Networks using the JSON specification file supplied. 26 | 27 | ???+ example "Sample JSON: Overlay-backed NSX Segments for Application Virtual Networks" 28 | 29 | ```json 30 | --8<-- "./samples/avns/avnOverlaySpec.json" 31 | ``` 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Add-VCFApplicationVirtualNetwork -json (Get-Content -Raw .\samples\avns\avnOverlaySpec.json) -validate 37 | ``` 38 | 39 | This example shows how to validate the Application Virtual Networks JSON specification file supplied. 40 | 41 | ???+ example "Sample JSON: VLAN-backed NSX Segments for Application Virtual Networks" 42 | 43 | ```json 44 | --8<-- "./samples/avns/avnVlanSpec.json" 45 | ``` 46 | 47 | ## Parameters 48 | 49 | ### -json 50 | 51 | Specifies the JSON specification to be used. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: 1 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -validate 66 | 67 | Specifies to validate the JSON specification file. 68 | 69 | ```yaml 70 | Type: SwitchParameter 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: False 75 | Position: Named 76 | Default value: False 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/avns/Get-VCFApplicationVirtualNetwork.md: -------------------------------------------------------------------------------- 1 | # Get-VCFApplicationVirtualNetwork 2 | 3 | ## Synopsis 4 | 5 | Retrieves Application Virtual Networks (AVN) from SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFApplicationVirtualNetwork [[-regionType] ] [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFApplicationVirtualNetwork` cmdlet retrieves the Application Virtual Networks configured in SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFApplicationVirtualNetwork 23 | ``` 24 | 25 | This example shows how to retrieve a list of Application Virtual Networks. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFApplicationVirtualNetwork -regionType REGION_A 31 | ``` 32 | 33 | This example shows how to retrieve the details of the regionType REGION_A Application Virtual Networks. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFApplicationVirtualNetwork -id 577e6262-73a9-4825-bdb9-4341753639ce 39 | ``` 40 | 41 | This example shows how to retrieve the details of the Application Virtual Networks using the id. 42 | 43 | ## Parameters 44 | 45 | ### -regionType 46 | 47 | Specifies the region. One of: REGION_A, REGION_B, X_REGION. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: False 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -id 62 | 63 | Specifies the unique ID of the Application Virtual Network. 64 | 65 | ```yaml 66 | Type: String 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: 2 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/backup-restore/Get-VCFBackupConfiguration.md: -------------------------------------------------------------------------------- 1 | # Get-VCFBackupConfiguration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the current backup configuration details from SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFBackupConfiguration 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFBackupConfiguration` cmdlet retrieves the current backup configuration details. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFBackupConfiguration 23 | ``` 24 | 25 | This example retrieves the backup configuration. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFBackupConfiguration | ConvertTo-Json 31 | ``` 32 | 33 | This example retrieves the backup configuration and outputs it in JSON format. 34 | -------------------------------------------------------------------------------- /docs/documentation/functions/backup-restore/Get-VCFRestoreTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFRestoreTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status of the restore task. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFRestoreTask [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFRestoreTask` cmdlet retrieves the status of the restore task. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFRestoreTask -id a5788c2d-3126-4c8f-bedf-c6b812c4a753 23 | ``` 24 | 25 | This example shows how to retrieve the status of the restore task by unique ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the restore task. 32 | 33 | ```yaml 34 | Type: String 35 | Parameter Sets: (All) 36 | Aliases: 37 | 38 | Required: False 39 | Position: 1 40 | Default value: None 41 | Accept pipeline input: False 42 | Accept wildcard characters: False 43 | ``` 44 | 45 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/backup-restore/Set-VCFBackupConfiguration.md: -------------------------------------------------------------------------------- 1 | # Set-VCFBackupConfiguration 2 | 3 | ## Synopsis 4 | 5 | Configures or updates the backup configuration details for backing up NSX and SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFBackupConfiguration [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFBackupConfiguration` cmdlet configures or updates the backup configuration details for backing up NSX and SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Set-VCFBackupConfiguration -json (Get-Content -Raw .\samples\backup-restore\backupSpec.json) 23 | ``` 24 | 25 | This example shows how to configure the backup configuration. 26 | 27 | ???+ example "Sample JSON: Configure Backup Settings" 28 | 29 | ```json 30 | --8<-- "./samples/backup-restore/backupSpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### Common Parameters 52 | 53 | 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). 54 | -------------------------------------------------------------------------------- /docs/documentation/functions/backup-restore/Start-VCFBackup.md: -------------------------------------------------------------------------------- 1 | # Start-VCFBackup 2 | 3 | ## Synopsis 4 | 5 | Starts the backup task in SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFBackup 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFBackup` cmdlet starts the backup task in SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-VCFBackup 23 | ``` 24 | 25 | This example shows how to start the backup task in SDDC Manager. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/backup-restore/Start-VCFRestore.md: -------------------------------------------------------------------------------- 1 | # Start-VCFRestore 2 | 3 | ## Synopsis 4 | 5 | Starts the SDDC Manager restore task. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFRestore [-backupFile] [-passphrase] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFRestore` cmdlet starts the SDDC Manager restore task. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-VCFRestore -backupFile "/tmp/vcf-backup-sfo-vcf01-sfo-rainpole-io-yyyy-mm-dd-00-00-00.tar.gz" -passphrase "VMw@re1!VMw@re1!" 23 | ``` 24 | 25 | This example shows how to start the SDDC Manager restore task. 26 | 27 | ## Parameters 28 | 29 | ### -backupFile 30 | 31 | Specifies the backup file to be used. 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 | ### -passphrase 46 | 47 | Specifies the passphrase to be used. 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 | ### Common Parameters 62 | 63 | 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). 64 | -------------------------------------------------------------------------------- /docs/documentation/functions/bundles/Get-VCFBundle.md: -------------------------------------------------------------------------------- 1 | # Get-VCFBundle 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of all bundles available to the SDDC Manager instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFBundle [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFBundle` cmdlet gets all bundles available to the SDDC Manager instance. 16 | 17 | ???+ info 18 | 19 | Includes bundles that are available via depot access and bundles that are manually uploaded. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFBundle 27 | ``` 28 | 29 | This example shows how to retrieve a list of all bundles available to the SDDC Manager instance. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Get-VCFBundle | Select version,downloadStatus,id 35 | ``` 36 | 37 | This example shows how to retrieve a list of all bundles available to the SDDC Manager instance and select specific properties. 38 | 39 | ### Example 3 40 | 41 | ```powershell 42 | Get-VCFBundle -id 7ef354ab-13a6-4e39-9561-10d2c4de89db 43 | ``` 44 | 45 | This example shows how to retrieve a list of details for a specific bundle using the unique ID of the bundle. 46 | 47 | ### Example 4 48 | 49 | ```powershell 50 | Get-VCFBundle | Where {$_.description -Match "NSX"} 51 | ``` 52 | 53 | This example shows how to retrieve a list of all bundles available to the SDDC Manager instance and filter the results by description. 54 | 55 | ## Parameters 56 | 57 | ### -id 58 | 59 | Specifies the unique ID of the bundle. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: False 67 | Position: 1 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### Common Parameters 74 | 75 | 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). 76 | -------------------------------------------------------------------------------- /docs/documentation/functions/bundles/Request-VCFBundle.md: -------------------------------------------------------------------------------- 1 | # Request-VCFBundle 2 | 3 | ## Synopsis 4 | 5 | Start download of bundle from depot. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VCFBundle [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VCFBundle` cmdlet starts an immediate download of a bundle from the depot. 16 | 17 | ???+ note 18 | 19 | Only one download can be triggered for a bundle. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-VCFBundle -id 7ef354ab-13a6-4e39-9561-10d2c4de89db 27 | ``` 28 | 29 | This example shows how to start an immediate download of a bundle from the depot using the unique ID of the bundle. 30 | 31 | ## Parameters 32 | 33 | ### -id 34 | 35 | Specifies the unique ID of the bundle. 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 | ### Common Parameters 50 | 51 | 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). 52 | -------------------------------------------------------------------------------- /docs/documentation/functions/bundles/Start-VCFBundleUpload.md: -------------------------------------------------------------------------------- 1 | # Start-VCFBundleUpload 2 | 3 | ## Synopsis 4 | 5 | Starts upload of bundle to SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFBundleUpload [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFBundleUpload` cmdlet starts upload of bundle(s) to SDDC Manager 16 | 17 | ???+ note 18 | 19 | The bundle must be downloaded to SDDC Manager appliance using the bundle transfer utility. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Start-VCFBundleUpload -json (Get-Content -Raw .\samples\bundles\bundleUploadSpec.json) 27 | ``` 28 | 29 | This example invokes the upload of a bundle onto SDDC Manager by passing a JSON specification file. 30 | 31 | ???+ example "Sample JSON: Upload Bundle" 32 | 33 | ```json 34 | --8<-- "./samples/bundles/bundleUploadSpec.json" 35 | ``` 36 | 37 | ## Parameters 38 | 39 | ### -json 40 | 41 | Specifies the JSON specification to be used. 42 | 43 | ```yaml 44 | Type: String 45 | Parameter Sets: (All) 46 | Aliases: 47 | 48 | Required: True 49 | Position: 1 50 | Default value: None 51 | Accept pipeline input: False 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### Common Parameters 56 | 57 | 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). 58 | -------------------------------------------------------------------------------- /docs/documentation/functions/ceip/Get-VCFCeip.md: -------------------------------------------------------------------------------- 1 | # Get-VCFCeip 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status for the Customer Experience Improvement Program (CEIP) for SDDC Manager, vCenter Server, vSAN, and NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFCeip 11 | ``` 12 | 13 | ## Description 14 | 15 | The Get-VCFCeip cmdlet retrieves the current setting for the Customer Experience Improvement Program (CEIP) of the connected SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFCeip 23 | ``` 24 | 25 | This example shows how to retrieve the current setting of the Customer Experience Improvement Program for SDDC Manager, vCenter Server, vSAN, and NSX. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/ceip/Set-VCFCeip.md: -------------------------------------------------------------------------------- 1 | # Set-VCFCeip 2 | 3 | ## Synopsis 4 | 5 | Sets the Customer Experience Improvement Program (CEIP) status for SDDC Manager, vCenter Server, vSAN, and NSX. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFCeip [-ceipSetting] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The Set-VCFCeip cmdlet configures the status for the Customer Experience Improvement Program (CEIP) for SDDC Manager, vCenter Server, vSAN, and NSX. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Set-VCFCeip -ceipSetting DISABLE 23 | ``` 24 | 25 | This example shows how to disable the Customer Experience Improvement Program for SDDC Manager, vCenter Server, vSAN, and NSX. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Set-VCFCeip -ceipSetting ENABLE 31 | ``` 32 | 33 | This example shows how to enable the Customer Experience Improvement Program for SDDC Manager, vCenter Server, vSAN, and NSX. 34 | 35 | ## Parameters 36 | 37 | ### -ceipSetting 38 | 39 | Specifies the configuration of the Customer Experience Improvement Program. One of: ENABLE, DISABLE. 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 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/certificates/Get-VCFCertificateAuthority.md: -------------------------------------------------------------------------------- 1 | # Get-VCFCertificateAuthority 2 | 3 | ## Synopsis 4 | 5 | Retrieves the certificate authority information. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFCertificateAuthority [[-caType] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFCertificateAuthority` cmdlet retrieves the certificate authority configuration from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFCertificateAuthority 23 | ``` 24 | 25 | This example shows how to retrieve the certificate authority configuration from SDDC Manager. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFCertificateAuthority | ConvertTo-Json 31 | ``` 32 | 33 | This example shows how to retrieve the certificate authority configuration from SDDC Manager and convert the output to JSON. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFCertificateAuthority -caType Microsoft 39 | ``` 40 | 41 | This example shows how to retrieve the certificate authority configuration for a Microsoft Certificate Authority from SDDC Manager. 42 | 43 | ## Parameters 44 | 45 | ### -caType 46 | 47 | Specifies the certificate authority type. One of: Microsoft, OpenSSL. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: False 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### Common Parameters 62 | 63 | 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). 64 | -------------------------------------------------------------------------------- /docs/documentation/functions/certificates/Get-VCFCertificateCsr.md: -------------------------------------------------------------------------------- 1 | # Get-VCFCertificateCsr 2 | 3 | ## Synopsis 4 | 5 | Retrieve the latest generated certificate signing request(s) (CSR) for a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFCertificateCsr [-domainName] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFCertificateCsr` cmdlet gets the available certificate signing request(s) (CSR) for a workload domain. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFCertificateCsr -domainName sfo-m01 23 | ``` 24 | 25 | This example shows how to retrieve the available certificate signing request(s) (CSR) for a workload domain. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFCertificateCsr -domainName sfo-m01 | ConvertTo-Json 31 | ``` 32 | 33 | This example shows how to retrieve the available certificate signing request(s) (CSR) for a workload domain and convert the output to JSON. 34 | 35 | ## Parameters 36 | 37 | ### -domainName 38 | 39 | Specifies the name of the workload domain. 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 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/certificates/Remove-VCFCertificateAuthority.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFCertificateAuthority 2 | 3 | ## Synopsis 4 | 5 | Removes the certificate authority configuration. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFCertificateAuthority [-caType] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFCertificateAuthority` cmdlet removes the certificate authority configuration from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Remove-VCFCertificateAuthority 23 | ``` 24 | 25 | This example shows how to remove the certificate authority configuration from SDDC Manager. 26 | 27 | ## Parameters 28 | 29 | ### -caType 30 | 31 | Specifies the certificate authority type. One of: Microsoft, OpenSSL. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/certificates/Request-VCFCertificate.md: -------------------------------------------------------------------------------- 1 | # Request-VCFCertificate 2 | 3 | ## Synopsis 4 | 5 | Generate a certificate(s) for the selected resource(s) in a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VCFCertificate [-json] [-domainName] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VCFCertificate` cmdlet generates certificate(s) for the selected resource(s) in a workload domain. 16 | 17 | ???+ note 18 | 19 | The cerificate authority must be configured and the certificate signing request must be generated beforehand. 20 | 21 | ???+ info 22 | 23 | The resources that can be requested are: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER. 24 | 25 | ## Examples 26 | 27 | ### Example 1 28 | 29 | ```powershell 30 | Request-VCFCertificate -domainName MGMT -json (Get-Content -Raw .\samples\certificates\requestCertificateSpec.json) 31 | ``` 32 | 33 | This example shows how to generate the certificate(s) based on the entries within the JSON specification file for resources within the workload domain named MGMT. 34 | 35 | ???+ example "Sample JSON: Request Certificate" 36 | 37 | ```json 38 | --8<-- "./samples/certificates/requestCertificateSpec.json" 39 | ``` 40 | 41 | ## Parameters 42 | 43 | ### -json 44 | 45 | Specifies the JSON specification to be used. 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 | ### -domainName 60 | 61 | Specifies the name of the workload domain. 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 | ### Common Parameters 76 | 77 | 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). 78 | -------------------------------------------------------------------------------- /docs/documentation/functions/certificates/Request-VCFCertificateCsr.md: -------------------------------------------------------------------------------- 1 | # Request-VCFCertificateCsr 2 | 3 | ## Synopsis 4 | 5 | Generate a certificate signing request(s) (CSR) for the selected resource(s) in a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VCFCertificateCsr [-json] [-domainName] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The Request-VCFCertificateCsr generates a certificate signing request(s) (CSR) for the selected resource(s) in a workload domain. 16 | 17 | ???+ info 18 | 19 | The resources that can be requested are: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-VCFCertificateCsr -domainName MGMT -json (Get-Content -Raw .\samples\certificates\requestCsrSpec.json) 27 | ``` 28 | 29 | This example shows how to generate the certificate signing request(s) (CSR) based on the entries within the JSON specification file for resources within the workload domain named MGMT. 30 | 31 | ???+ example "Sample JSON: Request Certificate Signing Request" 32 | 33 | ```json 34 | --8<-- "./samples/certificates/requestCsrSpec.json" 35 | ``` 36 | 37 | ## Parameters 38 | 39 | ### -json 40 | 41 | Specifies the JSON specification to be used. 42 | 43 | ```yaml 44 | Type: String 45 | Parameter Sets: (All) 46 | Aliases: 47 | 48 | Required: True 49 | Position: 1 50 | Default value: None 51 | Accept pipeline input: False 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -domainName 56 | 57 | Specifies the name of the workload domain. 58 | 59 | ```yaml 60 | Type: String 61 | Parameter Sets: (All) 62 | Aliases: 63 | 64 | Required: True 65 | Position: 2 66 | Default value: None 67 | Accept pipeline input: False 68 | Accept wildcard characters: False 69 | ``` 70 | 71 | ### Common Parameters 72 | 73 | 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). 74 | -------------------------------------------------------------------------------- /docs/documentation/functions/certificates/Set-VCFCertificate.md: -------------------------------------------------------------------------------- 1 | # Set-VCFCertificate 2 | 3 | ## Synopsis 4 | 5 | Install certificate(s) for the selected resource(s) in a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFCertificate [-json] [-domainName] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFCertificate` cmdlet installs certificate(s) for the selected resource(s) in a workload domain. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Set-VCFCertificate -domainName MGMT -json (Get-Content -Raw .\samples\certificates\updateCertificateSpec.json) 23 | ``` 24 | 25 | This example shows how to install the certificate(s) for the resources within the domain called MGMT based on the entries within the JSON specification file. 26 | 27 | ???+ example "Sample JSON: Install Certificates" 28 | 29 | ```json 30 | --8<-- "./samples/certificates/updateCertificateSpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### -domainName 52 | 53 | Specifies the name of the workload domain. 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 | ### Common Parameters 68 | 69 | 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). 70 | -------------------------------------------------------------------------------- /docs/documentation/functions/clusters/Get-VCFClusterValidation.md: -------------------------------------------------------------------------------- 1 | # Get-VCFClusterValidation 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status of the validation task for the cluster JSON specification. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFClusterValidation [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFClusterValidation` cmdlet retrieves the status of the validation task for the cluster JSON specification. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFClusterValidation -id 001235d8-3e40-4a5a-8a89-09985dac1434 23 | ``` 24 | 25 | This example shows how to retrieve validation task for the cluster JSON specification by unique ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the validation task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/clusters/Remove-VCFCluster.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFCluster 2 | 3 | ## Synopsis 4 | 5 | Removes a cluster from a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFCluster [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFCluster` cmdlet removes a cluster from a workload domain. 16 | 17 | ???+ note 18 | 19 | Before a cluster can be deleted it must first be marked for deletion. 20 | Please see [Set-VCFCluster](Set-VCFCluster.md) for more information. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Remove-VCFCluster -id a511b625-8eb8-417e-85f0-5b47ebb4c0f1 28 | ``` 29 | 30 | This example shows how to remove a cluster from a workload domain by unique ID. 31 | 32 | ## Parameters 33 | 34 | ### -id 35 | 36 | Specifies the unique ID of the cluster. 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 | ### Common Parameters 51 | 52 | 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). 53 | -------------------------------------------------------------------------------- /docs/documentation/functions/compliance/Get-VCFComplianceHistory.md: -------------------------------------------------------------------------------- 1 | # Get-VCFComplianceHistory 2 | 3 | ## Synopsis 4 | 5 | Retrieves the history for all compliance audits that have been performed. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFComplianceHistory 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFComplianceHistory` cmdlet retrieves the history for all compliance audits that have been performed. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFComplianceHistory 23 | 24 | id : b0762a5f-c575-4e1a-a002-de32e9e9426d 25 | creationTimestamp : 7/30/2024 9:31:45 PM 26 | completionTimestamp : 7/30/2024 9:31:47 PM 27 | standardType : PCI 28 | standardVersion : 4.0 29 | domainId : 6ca52d6b-9292-4baf-ab97-75c3a74d4bf2 30 | configurationEvaluationStatus : SOME_EVALUATED 31 | configurationEvaluationStatusDetails : [1605, 1604] configurations were skipped in audit. Follow the audit procedure to run them manually. 32 | compliantStatus : PARTIALLY_COMPLIANT 33 | totalConfigurationsEvaluated : 9 34 | numberOfNonCompliantConfigurations : 5 35 | numberOfSkippedConfigurations : 2 36 | numberOfAuditItems : 9 37 | 38 | id : e2b165c7-0118-4064-9f41-33639fb37195 39 | creationTimestamp : 7/30/2024 10:52:31 PM 40 | completionTimestamp : 7/30/2024 10:52:32 PM 41 | standardType : PCI 42 | standardVersion : 4.0 43 | domainId : 6ca52d6b-9292-4baf-ab97-75c3a74d4bf2 44 | configurationEvaluationStatus : SOME_EVALUATED 45 | configurationEvaluationStatusDetails : [1605, 1604] configurations were skipped in audit. Follow the audit procedure to run them manually. 46 | compliantStatus : PARTIALLY_COMPLIANT 47 | totalConfigurationsEvaluated : 9 48 | numberOfNonCompliantConfigurations : 5 49 | numberOfSkippedConfigurations : 2 50 | numberOfAuditItems : 9 51 | ``` 52 | 53 | This example shows how to retrieve the history for all compliance audits that have been performed. 54 | -------------------------------------------------------------------------------- /docs/documentation/functions/compliance/Get-VCFComplianceStandard.md: -------------------------------------------------------------------------------- 1 | # Get-VCFComplianceStandard 2 | 3 | ## Synopsis 4 | 5 | Retrieves the list of all compliance audit standards and versions that are supported. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFComplianceConfiguration 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFComplianceStandard` cmdlet retrieves the the list of all compliance audit standards and versions that are supported. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFComplianceStandard 23 | 24 | standardType standardVersions 25 | ------------ ---------------- 26 | PCI {4.0} 27 | ``` 28 | 29 | This example shows how to retrieve a list of all compliance audit standards and versions. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/compliance/Get-VCFComplianceTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFComplianceTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves the list of all compliance configurations along with their applicable resource types and versions. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFComplianceTask [-domainName] [-complianceTaskId] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFComplianceTask` cmdlet retrieves the compliance audit id and progress using the task id returned from the `New-VCFCompliance` operation. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFComplianceTask -domainName "sfo-m01" -complianceTaskId "d22c47e0-8d38-43da-975b-938e7c59f4d6" 23 | 24 | id status complianceAuditId 25 | -- ------ ----------------- 26 | d22c47e0-8d38-43da-975b-938e7c59f4d6 SUCCESSFUL 1758e972-8509-4dce-93d9-a303d7c35a41 27 | ``` 28 | 29 | This example shows how to retrieve the compliance audit id and progress using the task id returned from the `New-VCFCompliance` operation. 30 | 31 | ## Parameters 32 | 33 | ### -domainName 34 | 35 | Specifies the name of the workload domain. 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 | ### -complianceTaskId 50 | 51 | Specifies the compliance task returned from `New-VCFCompliance`. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: Named 60 | Default value: False 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### Common Parameters 66 | 67 | 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). 68 | -------------------------------------------------------------------------------- /docs/documentation/functions/credentials/Restart-VCFCredentialTask.md: -------------------------------------------------------------------------------- 1 | # Restart-VCFCredentialTask 2 | 3 | ## Synopsis 4 | 5 | Restarts a failed rotate/update password task. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Restart-VCFCredentialTask [-id] [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Restart-VCFCredentialTask` cmdlet restarts a failed rotate/update password task. You can restart a failed rotate/update password task by unique ID and JSON specification file. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Restart-VCFCredentialTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d -json .\samples\credentials\updateCredentialSpec.json 23 | ``` 24 | 25 | This example shows how to update passwords of a resource type using a JSON specification file. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the credential task. 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 | ### -json 46 | 47 | Specifies the JSON specification to be used. 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 | ### Common Parameters 62 | 63 | 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). 64 | -------------------------------------------------------------------------------- /docs/documentation/functions/credentials/Set-VCFCredential.md: -------------------------------------------------------------------------------- 1 | # Set-VCFCredential 2 | 3 | ## Synopsis 4 | 5 | Updates or rotate a credential. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFCredential [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFCredential` cmdlet updates or rotates a credential. 16 | 17 | ???+ info 18 | 19 | Credentials can be updated with a specified password(s) or rotated using system generated password(s). 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Set-VCFCredential -json .\samples\credentials\updateCredentialSpec.json 27 | ``` 28 | 29 | This example shows how to update a credential using a JSON specification file. 30 | 31 | ???+ example "Sample JSON: Update Credential" 32 | 33 | ```json 34 | --8<-- "./samples/credentials/updateCredentialSpec.json" 35 | ``` 36 | 37 | ### Example 2 38 | 39 | ```powershell 40 | Set-VCFCredential -json .\samples\credentials\rotateCredentialSpec.json 41 | ``` 42 | 43 | This example shows how to rotate a credential using a JSON specification file. 44 | 45 | ???+ example "Sample JSON: Rotate Credential" 46 | 47 | ```json 48 | --8<-- "./samples/credentials/rotateCredentialSpec.json" 49 | ``` 50 | 51 | ## Parameters 52 | 53 | ### -json 54 | 55 | Specifies the JSON specification to be used. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: True 63 | Position: 1 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### Common Parameters 70 | 71 | 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). 72 | -------------------------------------------------------------------------------- /docs/documentation/functions/credentials/Stop-VCFCredentialTask.md: -------------------------------------------------------------------------------- 1 | # Stop-VCFCredentialTask 2 | 3 | ## Synopsis 4 | 5 | Stops a failed rotate/update password task. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Stop-VCFCredentialTask [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Stop-VCFCredentialTask` cmdlet stops a failed rotate/update password task. You can stop a failed rotate/update password task by unique ID. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Stop-VCFCredentialTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d 23 | ``` 24 | 25 | This example shows how to cancel a failed rotate or update password task by unique ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the credential task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/depots/Get-VCFDepotCredential.md: -------------------------------------------------------------------------------- 1 | # Get-VCFDepotCredential 2 | 3 | ## Synopsis 4 | 5 | Retrieves the configurations for the depot configured in the SDDC Manager instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFDepotCredential [-vxrail] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFDepotCredential` cmdlet retrieves the configurations for the depot configured in the SDDC Manager instance. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFDepotCredential 23 | ``` 24 | 25 | This example shows how to retrieve the credentials for VMware Customer Connect. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFDepotCredential -vxrail 31 | ``` 32 | 33 | This example shows how to retrieve the credentials for Dell EMC Support. 34 | 35 | ## Parameters 36 | 37 | ### -vxrail 38 | 39 | Specifies that the cmdlet retrieves the credentials for Dell EMC Support. 40 | 41 | ```yaml 42 | Type: SwitchParameter 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: Named 48 | Default value: False 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/depots/Set-VCFDepotCredential.md: -------------------------------------------------------------------------------- 1 | # Set-VCFDepotCredential 2 | 3 | ## Synopsis 4 | 5 | Updates the configuration for the depot of the connected SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFDepotCredential -username -password [-vxrail] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFDepotCredential` cmdlets updates the configuration for the depot of the connected SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Set-VCFDepotCredential -username "support@rainpole.io" -password "VMw@re1!" 23 | ``` 24 | 25 | This example sets the credentials for VMware Customer Connect. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Set-VCFDepotCredential -vxrail -username "support@rainpole.io" -password "VMw@re1!" 31 | ``` 32 | 33 | This example sets the credentials for Dell EMC Support. 34 | 35 | ## Parameters 36 | 37 | ### -username 38 | 39 | Specifies the username for the depot. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: True 47 | Position: Named 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### -password 54 | 55 | Specifies the password for the depot. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -vxrail 70 | 71 | Specifies that the cmdlet sets the credentials for Dell EMC Support. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: 77 | 78 | Required: False 79 | Position: Named 80 | Default value: False 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### Common Parameters 86 | 87 | 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). 88 | -------------------------------------------------------------------------------- /docs/documentation/functions/dns-ntp/Get-VCFConfigurationDNS.md: -------------------------------------------------------------------------------- 1 | # Get-VCFConfigurationDNS 2 | 3 | ## Synopsis 4 | 5 | Retrieves the DNS configuration. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFConfigurationDNS 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFConfigurationDNS` cmdlet retrieves the DNS configuration from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFConfigurationDNS 23 | ``` 24 | 25 | This example shows how to retrieve the DNS configuration from SDDC Manager. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/dns-ntp/Get-VCFConfigurationDNSValidation.md: -------------------------------------------------------------------------------- 1 | # Get-VCFConfigurationDNSValidation 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status of the validation of the DNS configuration. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFConfigurationDNSValidation [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFConfigurationDNSValidation` cmdlet retrieves the status of the validation of the DNS configuration. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFConfigurationDNSValidation -id d729fcc5-fb61-2d05-aa40-9c7686163fa1 23 | ``` 24 | 25 | This example shows how to retrieve the status of the validation of the DNS configuration. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the validation task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/dns-ntp/Get-VCFConfigurationNTP.md: -------------------------------------------------------------------------------- 1 | # Get-VCFConfigurationNTP 2 | 3 | ## Synopsis 4 | 5 | Retrieves the NTP configuration. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFConfigurationNTP 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFConfigurationNTP` cmdlet retrieves the NTP configuration from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFConfigurationNTP 23 | ``` 24 | 25 | This example shows how to retrieve the NTP configuration from SDDC Manager. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/dns-ntp/Get-VCFConfigurationNTPValidation.md: -------------------------------------------------------------------------------- 1 | # Get-VCFConfigurationNTPValidation 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status of the validation of the NTP configuration. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFConfigurationNTPValidation [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFConfigurationNTPValidation` cmdlet retrieves the status of the validation of the NTP configuration. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFConfigurationNTPValidation -id a749fcc5-fb61-2d05-aa40-9c7686164fc2 23 | ``` 24 | 25 | This example shows how to retrieve the status of the validation of the NTP configuration. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the validation task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/dns-ntp/Set-VCFConfigurationDNS.md: -------------------------------------------------------------------------------- 1 | # Set-VCFConfigurationDNS 2 | 3 | ## Synopsis 4 | 5 | Sets the DNS configuration for all systems managed by SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFConfigurationDNS [-json] [-validate] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFConfigurationDNS` cmdlet sets the DNS configuration for all systems managed by SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Set-VCFConfigurationDNS -json (Get-Content -Raw .\samples\dns-ntp\dnsSpec.json) 23 | ``` 24 | 25 | This example shows how to set the DNS configuration for all systems managed by SDDC Manager using a JSON specification file. 26 | 27 | ???+ example "Sample JSON: DNS Configuration" 28 | 29 | ```json 30 | --8<-- "./samples/dns-ntp/dnsSpec.json" 31 | ``` 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Set-VCFConfigurationDNS -json (Get-Content -Raw .\samples\dns-ntp\dnsSpec.json) -validate 37 | ``` 38 | 39 | This example shows how to validate the DNS configuration. 40 | 41 | ## Parameters 42 | 43 | ### -json 44 | 45 | Specifies the JSON specification to be used. 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 | ### -validate 60 | 61 | Specifies to validate the JSON specification file. 62 | 63 | ```yaml 64 | Type: SwitchParameter 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: False 69 | Position: Named 70 | Default value: False 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### Common Parameters 76 | 77 | 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). 78 | -------------------------------------------------------------------------------- /docs/documentation/functions/dns-ntp/Set-VCFConfigurationNTP.md: -------------------------------------------------------------------------------- 1 | # Set-VCFConfigurationNTP 2 | 3 | ## Synopsis 4 | 5 | Sets the NTP configuration for all systems managed by SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFConfigurationNTP [-json] [-validate] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFConfigurationNTP` cmdlet sets the NTP configuration for all systems managed by SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Set-VCFConfigurationNTP (Get-Content -Raw .\samples\dns-ntp\ntpSpec.json) 23 | ``` 24 | 25 | This example shows how to set the NTP configuration for all systems managed by SDDC Manager using a JSON specification file. 26 | 27 | ???+ example "Sample JSON: NTP Configuration" 28 | 29 | ```json 30 | --8<-- "./samples/dns-ntp/ntpSpec.json" 31 | ``` 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Set-VCFConfigurationNTP -json (Get-Content -Raw .\samples\dns-ntp\ntpSpec.json) -validate 37 | ``` 38 | 39 | This example shows how to validate the NTP configuration. 40 | 41 | ## Parameters 42 | 43 | ### -json 44 | 45 | Specifies the JSON specification to be used. 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 | ### -validate 60 | 61 | Specifies to validate the JSON specification file. 62 | 63 | ```yaml 64 | Type: SwitchParameter 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: False 69 | Position: Named 70 | Default value: False 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### Common Parameters 76 | 77 | 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). 78 | -------------------------------------------------------------------------------- /docs/documentation/functions/domains/New-VCFWorkloadDomain.md: -------------------------------------------------------------------------------- 1 | # New-VCFWorkloadDomain 2 | 3 | ## Synopsis 4 | 5 | Creates a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFWorkloadDomain [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFWorkloadDomain` cmdlet creates a workload domain from a JSON specification file. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFWorkloadDomain -json .\samples\domains\domainSpec.json 23 | ``` 24 | 25 | This example shows how to create a workload domain from a JSON specification file. 26 | 27 | ???+ example "Sample JSON: Workload Domain" 28 | 29 | ```json 30 | --8<-- "./samples/domains/domainSpec.json" 31 | ``` 32 | ???+ example "Sample JSON: Isolated Workload Domain" 33 | 34 | ```json 35 | --8<-- "./samples/domains/isolatedDomainSpec.json" 36 | ``` 37 | 38 | ### Example 2 39 | 40 | ```powershell 41 | New-VCFWorkloadDomain -json .\samples\domains\domainSpec.json -validate 42 | ``` 43 | 44 | This example shows how to validate the workload domain JSON specification file. 45 | 46 | ## Parameters 47 | 48 | ### -json 49 | 50 | Specifies the JSON specification to be used. 51 | 52 | ```yaml 53 | Type: String 54 | Parameter Sets: (All) 55 | Aliases: 56 | 57 | Required: True 58 | Position: 1 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -validate 65 | 66 | Specifies to validate the JSON specification file. 67 | 68 | ```yaml 69 | Type: SwitchParameter 70 | Parameter Sets: (All) 71 | Aliases: 72 | 73 | Required: False 74 | Position: Named 75 | Default value: False 76 | Accept pipeline input: False 77 | Accept wildcard characters: False 78 | ``` 79 | 80 | ### Common Parameters 81 | 82 | 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). 83 | -------------------------------------------------------------------------------- /docs/documentation/functions/domains/Remove-VCFWorkloadDomain.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFWorkloadDomain 2 | 3 | ## Synopsis 4 | 5 | Removes a workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFWorkloadDomain [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFWorkloadDomain` cmdlet removes a workload domain from the SDDC Manager. You can specify the workload domain by unique ID. 16 | 17 | ???+ note 18 | 19 | Before a workload domain can be deleted it must first be marked for deletion. 20 | Please see [Set-VCFWorkloadDomain](Set-VCFWorkloadDomain.md) for more information. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Remove-VCFWorkloadDomain -id fbdcf199-c086-43aa-9071-5d53b5c5b99d 28 | ``` 29 | 30 | This example shows how to remove a workload domain by unique ID. 31 | 32 | ## Parameters 33 | 34 | ### -id 35 | 36 | Specifies the unique ID of the workload domain. 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 | ### Common Parameters 51 | 52 | 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). 53 | -------------------------------------------------------------------------------- /docs/documentation/functions/domains/Set-VCFWorkloadDomain.md: -------------------------------------------------------------------------------- 1 | # Set-VCFWorkloadDomain 2 | 3 | ## Synopsis 4 | 5 | Marks a workload domain for deletion. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFWorkloadDomain [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFWorkloadDomain` cmdlet marks a workload domain for deletion. 16 | 17 | ???+ info 18 | 19 | Before a workload domain can be removed it must first be marked for deletion. 20 | Please see [Remove-VCFWorkloadDomain](Remove-VCFWorkloadDomain.md) for more information. 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Set-VCFWorkloadDomain -id fbdcf199-c086-43aa-9071-5d53b5c5b99d 28 | ``` 29 | 30 | This example shows how to mark a workload domain for deletion. 31 | 32 | ## Parameters 33 | 34 | ### -id 35 | 36 | Specifies the unique ID of the workload domain. 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 | ### Common Parameters 51 | 52 | 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). 53 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/Get-VCFFederation.md: -------------------------------------------------------------------------------- 1 | # Get-VCFFederation 2 | 3 | ## Synopsis 4 | 5 | Retrieves the details for a federation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFFederation 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFFederation` cmdlet retrieves the details for a federation from SDDC Manager. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFFederation 27 | ``` 28 | 29 | This example shows how to retrieve the details for a federation from SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Get-VCFFederation | ConvertTo-Json 35 | ``` 36 | 37 | This example shows how to retrieve the details for a federation from SDDC Manager and convert the output to JSON. 38 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/Get-VCFFederationMember.md: -------------------------------------------------------------------------------- 1 | # Get-VCFFederationMember 2 | 3 | ## Synopsis 4 | 5 | Retrieves the information about the members of a federation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFFederationMember 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFFederationMember` cmdlets retrieves the information about all the members of a federation from SDDC Manager. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFFederationMember 27 | ``` 28 | 29 | This example shows how to retrieve the information about the members of a federation from SDDC Manager. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/Get-VCFFederationTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFFederationTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status of operations tasks in a federation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFFederationTask [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFFederationTask` cmdlet retrieves the status of operations tasks in a federation from SDDC Manager. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFFederationTask -id f6f38f6b-da0c-4ef9-9228-9330f3d30279 27 | ``` 28 | 29 | This example shows how to retrieve the status of operations tasks in a federation from SDDC Manager. 30 | 31 | ## Parameters 32 | 33 | ### -id 34 | 35 | Specifies the unique ID of the federation task. 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 | ### Common Parameters 50 | 51 | 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). 52 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/Join-VCFFederation.md: -------------------------------------------------------------------------------- 1 | # Join-VCFFederation 2 | 3 | ## Synopsis 4 | 5 | Join an SDDC Manager instance to an existing federation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Join-VCFFederation [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Join-VCFFederation` cmdlet joins an SDDC Manager instance to an existing federation. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Join-VCFFederation -json (Get-Content -Raw .\samples\federation\joinFederationSpec.json) 27 | ``` 28 | 29 | This example shows how to join an SDDC Manager instance to an existing federation. 30 | 31 | ???+ example "Sample JSON: Join Federation" 32 | 33 | ```json 34 | --8<-- "./samples/federation/joinFederationSpec.json" 35 | ``` 36 | 37 | ## Parameters 38 | 39 | ### -json 40 | 41 | Specifies the JSON specification to be used. 42 | 43 | ```yaml 44 | Type: String 45 | Parameter Sets: (All) 46 | Aliases: 47 | 48 | Required: True 49 | Position: 1 50 | Default value: None 51 | Accept pipeline input: False 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### Common Parameters 56 | 57 | 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). 58 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/New-VCFFederationInvite.md: -------------------------------------------------------------------------------- 1 | # New-VCFFederationInvite 2 | 3 | ## Synopsis 4 | 5 | Invites a member to join an existing federation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFFederationInvite [-inviteeFqdn] [-inviteeRole] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFFederationInvite` cmdlet invites a member to join an existing federation controller. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | New-VCFFederationInvite -inviteeFqdn lax-vcf01.lax.rainpole.io -inviteeRole MEMBER 27 | ``` 28 | 29 | This example shows how to invite a member to join an existing federation controller. 30 | 31 | ## Parameters 32 | 33 | ### -inviteeFqdn 34 | 35 | Specifies the fully qualified domain name (FQDN) of the member to invite to join the federation. 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 | ### -inviteeRole 50 | 51 | Specifies the role to ba assigned. One of: MEMBER, CONTROLLER. 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 | ### Common Parameters 66 | 67 | 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). 68 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/Remove-VCFFederation.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFFederation 2 | 3 | ## Synopsis 4 | 5 | Removes a federation from SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFFederation 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFFederation` cmdlet removes a federation from SDDC Manager. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Remove-VCFFederation 27 | ``` 28 | 29 | This example shows how to remove a federation from SDDC Manager. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/federation/Set-VCFFederation.md: -------------------------------------------------------------------------------- 1 | # Set-VCFFederation 2 | 3 | ## Synopsis 4 | 5 | Bootstraps the creation of a federation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFFederation [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFFederation` cmdlet bootstraps the creation of a federation in SDDC Manager. 16 | 17 | ???+ warning 18 | 19 | This API is was deprecated in VMware Cloud Foundation 4.3.0 and removed in VMware Cloud Foundation 4.4.0. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Set-VCFFederation -json (Get-Content -Raw .\samples\federation\federationSpec.json) 27 | ``` 28 | 29 | This example shows how to bootstrap the creation of a federation using a JSON specification file. 30 | 31 | ???+ example "Sample JSON: Create Federation" 32 | 33 | ```json 34 | --8<-- "./samples/federation/federationSpec.json" 35 | ``` 36 | 37 | ## Parameters 38 | 39 | ### -json 40 | 41 | Specifies the JSON specification to be used. 42 | 43 | ```yaml 44 | Type: String 45 | Parameter Sets: (All) 46 | Aliases: 47 | 48 | Required: True 49 | Position: 1 50 | Default value: None 51 | Accept pipeline input: False 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### Common Parameters 56 | 57 | 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). 58 | -------------------------------------------------------------------------------- /docs/documentation/functions/fips/Get-VCFFipsMode.md: -------------------------------------------------------------------------------- 1 | # Get-VCFFipsMode 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status for FIPS mode. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFFipsMode 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFFipsMode` cmdlet retrieves the status for FIPS mode on the VMware Cloud Foundation instance. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFFipsMode 23 | ``` 24 | 25 | This example shows how to retrieve the status for FIPS mode on the VMware Cloud Foundation instance. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/hosts/New-VCFCommissionedHost.md: -------------------------------------------------------------------------------- 1 | # New-VCFCommissionedHost 2 | 3 | ## Synopsis 4 | 5 | Commission a list of ESXi hosts. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFCommissionedHost [-json] [-validate] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFCommissionedHost` cmdlet commissions a list of ESXi hosts. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFCommissionedHost -json (Get-Content -Raw .\samples\hosts\commissionHostsSpec.json) 23 | ``` 24 | 25 | This example shows how to commission a list of ESXi hosts using a JSON specification files. 26 | 27 | ???+ example "Sample JSON: Commission ESXi Host(s) from SDDC Manager API JSON Spec" 28 | 29 | ```json 30 | --8<-- "./samples/hosts/commissionHostsSpec.json" 31 | ``` 32 | 33 | ???+ example "Sample JSON: Commission ESXi Host(s) from the JSON Spec Provided by the SDDC Manager UI" 34 | 35 | ```json 36 | --8<-- "./samples/hosts/ui-commissionHostsSpec.json" 37 | ``` 38 | 39 | ### Example 2 40 | 41 | ```powershell 42 | New-VCFCommissionedHost -json (Get-Content -Raw .\samples\hosts\commissionHostSpec.json) -validate 43 | ``` 44 | 45 | This example shows how to validate the ESXi host JSON specification file. 46 | 47 | ## Parameters 48 | 49 | ### -json 50 | 51 | Specifies the JSON specification to be used. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: 1 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -validate 66 | 67 | Specifies to validate the JSON specification file. 68 | 69 | ```yaml 70 | Type: SwitchParameter 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: False 75 | Position: Named 76 | Default value: False 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/hosts/Remove-VCFCommissionedHost.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFCommissionedHost 2 | 3 | ## Synopsis 4 | 5 | Decommissions a list of ESXi hosts. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFCommissionedHost [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFCommissionedHost` cmdlet decommissions a list of ESXi hosts. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Remove-VCFCommissionedHost -json (Get-Content -Raw .\samples\hosts\decommissionHostsSpec.json) 23 | ``` 24 | 25 | This example shows how to decommission a list of ESXi hosts using a JSON specification file. 26 | 27 | ???+ example "Sample JSON: Deommission ESXi Host(s)" 28 | 29 | ```json 30 | --8<-- "./samples/hosts/decommissionHostsSpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### Common Parameters 52 | 53 | 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). 54 | -------------------------------------------------------------------------------- /docs/documentation/functions/iam/Get-VCFRole.md: -------------------------------------------------------------------------------- 1 | # Get-VCFRole 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of roles. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFRole 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFRole` cmdlet retrieves a list of roles from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFRole 23 | ``` 24 | 25 | This example shows how to retrieve a list of roles from SDDC Manager. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/iam/Get-VCFUser.md: -------------------------------------------------------------------------------- 1 | # Get-VCFUser 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of users, groups, and service users. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFUser [[-type] ] [[-domain] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFUser` cmdlet retrieves a list of users, groups, and service users from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFUser 23 | ``` 24 | 25 | This example shows how to retrieve a list of users, groups, and service users from SDDC Manager. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFUser -type USER 31 | ``` 32 | 33 | This example shows how to retrieve a list of users from SDDC Manager. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFUser -type GROUP 39 | ``` 40 | 41 | This example shows how to retrieve a list of groups from SDDC Manager. 42 | 43 | ### Example 4 44 | 45 | ```powershell 46 | Get-VCFUser -type SERVICE 47 | ``` 48 | 49 | This example shows how to retrieve a list of service users from SDDC Manager. 50 | 51 | ### Example 5 52 | 53 | ```powershell 54 | Get-VCFUser -domain rainpole.io 55 | ``` 56 | 57 | This example shows how to retrieve a list of users, groups, and service users from an authentication domain. 58 | 59 | ## Parameters 60 | 61 | ### -type 62 | 63 | Specifies the type of user to retrieve. One of: USER, GROUP, SERVICE. 64 | 65 | ```yaml 66 | Type: String 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: 1 72 | Default value: None 73 | Accept pipeline input: False 74 | Accept wildcard characters: False 75 | ``` 76 | 77 | ### -domain 78 | 79 | Specifies the authentication domain to retrieve users from. 80 | 81 | ```yaml 82 | Type: String 83 | Parameter Sets: (All) 84 | Aliases: 85 | 86 | Required: False 87 | Position: 2 88 | Default value: None 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/iam/New-VCFGroup.md: -------------------------------------------------------------------------------- 1 | # New-VCFGroup 2 | 3 | ## Synopsis 4 | 5 | Adds a new group with a specified role. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFGroup [-group] [-domain] [-role] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFGroup` cmdlet adds a new group with a specified role to SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFGroup -group ug-vcf-group -domain rainpole.io -role ADMIN 23 | ``` 24 | 25 | This example shows how to add a new group with a specified role. 26 | 27 | ## Parameters 28 | 29 | ### -group 30 | 31 | Specifies the name of the group. 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 | ### -domain 46 | 47 | Specifies the authentication domain for the group. 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 | ### -role 62 | 63 | Specifies the role for the group in the SDDC Manager. One of: ADMIN, OPERATOR, VIEWER. 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/iam/New-VCFServiceUser.md: -------------------------------------------------------------------------------- 1 | # New-VCFServiceUser 2 | 3 | ## Synopsis 4 | 5 | Adds a service user. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFServiceUser [-user] [-role] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFServiceUser` cmdlet adds a service user to SDDC Manager with a specified role. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFServiceUser -user svc-user@rainpole.io -role ADMIN 23 | ``` 24 | 25 | This example shows how to add a service user with a specified role. 26 | 27 | ## Parameters 28 | 29 | ### -user 30 | 31 | Specifies the name of the service user. 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 | ### -role 46 | 47 | Specifies the role for the service user. One of: ADMIN, OPERATOR, VIEWER. 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 | ### Common Parameters 62 | 63 | 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). 64 | -------------------------------------------------------------------------------- /docs/documentation/functions/iam/New-VCFUser.md: -------------------------------------------------------------------------------- 1 | # New-VCFUser 2 | 3 | ## Synopsis 4 | 5 | Adds a new user. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFUser [-user] [-role] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFUser` cmdlet adds a new user to SDDC Manager with a specified role. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFUser -user vcf-admin@rainpole.io -role ADMIN 23 | ``` 24 | 25 | This example shows how to add a new user with a specified role. 26 | 27 | ## Parameters 28 | 29 | ### -user 30 | 31 | Specifies the name of the user. 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 | ### -role 46 | 47 | Specifies the role for the user. One of: ADMIN, OPERATOR, VIEWER. 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 | ### Common Parameters 62 | 63 | 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). 64 | -------------------------------------------------------------------------------- /docs/documentation/functions/iam/Remove-VCFUser.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFUser 2 | 3 | ## Synopsis 4 | 5 | Removes a user. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFUser [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFUser` cmdlet removes a user from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Remove-VCFUser -id c769fcc5-fb61-4d05-aa40-9c7786163fb5 23 | ``` 24 | 25 | This example shows how to remove a user from SDDC Manager. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the user to remove. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/idp/Get-VCFIdentityProvider.md: -------------------------------------------------------------------------------- 1 | # Get-VCFIdentityProvider 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of all identity providers or the details of a specific identity provider. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFIdentityProvider [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFIdentityProvider` cmdlet retrieves a list of all identity providers or the details of a specific identity provider. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFIdentityProvider 23 | ``` 24 | 25 | This example shows how to retrieve the details of all identity providers. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFIdentityProvider -id 3e250ddd-07ec-4923-a161-ab6e9aa588181 31 | ``` 32 | 33 | This example shows how to retrieve the details of a specific identity provider. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the identity provider. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/idp/New-VCFIdentityProvider.md: -------------------------------------------------------------------------------- 1 | # New-VCFIdentityProvider 2 | 3 | ## Synopsis 4 | 5 | Configures an identity provider. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFIdentityProvider [-type] [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFIdentityProvider` cmdlet configures an embedded or external identity provider from a JSON specification file. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFIdentityProvider -type Embedded -json .\samples\idp\embeddedIdpSpec.json 23 | ``` 24 | 25 | This example shows how to configure an embedded identity provider from the JSON specification file. 26 | 27 | ???+ example "Sample JSON: Embedded Identity Provider" 28 | 29 | ```json 30 | --8<-- "./samples/idp/embeddedIdpSpec.json" 31 | ``` 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | New-VCFIdentityProvider -type "Microsoft ADFS" -json .\samples\idp\externalIdpSpec.json 37 | ``` 38 | 39 | This example shows how to configure an external identity provider from the JSON specification file. 40 | 41 | ???+ example "Sample JSON: External Identity Provider" 42 | 43 | ```json 44 | --8<-- "./samples/idp/externalIdpSpec.json" 45 | ``` 46 | 47 | ## Parameters 48 | 49 | ### -type 50 | 51 | Specifies the type of the identity provider. One of: `Embedded`, `Microsoft ADFS`. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: 1 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -json 66 | 67 | Specifies the JSON specification file to be used. 68 | 69 | ```yaml 70 | Type: String 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: True 75 | Position: 2 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/idp/Remove-VCFIdentityProvider.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFIdentityProvider 2 | 3 | ## Synopsis 4 | 5 | Removes an identity provider. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFIdentityProvider [-type] [[-domainName] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The Remove-VCFIdentityProvider cmdlet removes an identity provider. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Remove-VCFIdentityProvider -type Embedded -domainName sfo.rainpole.io. 23 | ``` 24 | 25 | This example shows how to remove an embedded identity provider with a specific domain name. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Remove-VCFIdentityProvider -type "Microsoft ADFS". 31 | ``` 32 | 33 | This example shows how to remove an external identity provider. 34 | 35 | ## Parameters 36 | 37 | ### -type 38 | 39 | Specifies the type of the identity provider. One of: `Embedded`, `Microsoft ADFS`. 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 | ### -domainName 54 | 55 | Specifies the domain name of the identity provider. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: False 63 | Position: 2 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### Common Parameters 70 | 71 | 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). 72 | -------------------------------------------------------------------------------- /docs/documentation/functions/json-export/Export-VCFManagementDomainJsonSpec.md: -------------------------------------------------------------------------------- 1 | # Export-VCFManagementDomainJsonSpec 2 | 3 | ## Synopsis 4 | 5 | Generates a JSON file from the VMware Cloud Foundation Planning & Preparation Workbook to perform a VMware Cloud Foundation Bring-up. Requires the installation of the ImportExcel Powershell module. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Export-VCFManagementDomainJsonSpec [[-workbook] ] [[-jsonPath] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Export-VCFManagementDomainJsonSpec` cmdlet Generates a JSON file from the VCF Planning & Preparation Workbook to perform a VCF bringup. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Export-VCFManagementDomainJsonSpec -workbook vcf-pnp.xlsx -jsonPath ./ 23 | ``` 24 | 25 | This example will open the Planning & Preparation workbook and extract the required data to create a bringup JSON. 26 | 27 | ## Parameters 28 | 29 | ### -workbook 30 | 31 | Specifies the path to the Planning & Preparation Excel workbook. 32 | 33 | ```yaml 34 | Type: String 35 | Parameter Sets: (All) 36 | Aliases: 37 | 38 | Required: False 39 | Position: 1 40 | Default value: None 41 | Accept pipeline input: False 42 | Accept wildcard characters: False 43 | ``` 44 | 45 | ### -jsonPath 46 | 47 | Specifies the output path for the json file. JSON file name will be 'management_domain_name-domainSpec.json' 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: False 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### Common Parameters 62 | 63 | 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). 64 | -------------------------------------------------------------------------------- /docs/documentation/functions/licenses/Get-VCFLicenseMode.md: -------------------------------------------------------------------------------- 1 | # Get-VCFLicenseMode 2 | 3 | ## Synopsis 4 | 5 | Retrieves the current license mode. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFLicenseMode 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFLicenseMode` cmdlet retrieves the current license mode. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFLicenseMode 23 | ``` 24 | 25 | This example shows how to retrieve the current license mode. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/licenses/New-VCFLicenseKey.md: -------------------------------------------------------------------------------- 1 | # New-VCFLicenseKey 2 | 3 | ## Synopsis 4 | 5 | Adds a license key. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFLicenseKey [-key] [-productType] [-description] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFLicenseKey` cmdlet adds a new license key to SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFLicenseKey -key "AAAAA-AAAAA-AAAAA-AAAAA-AAAAA" -productType VCENTER -description "vCenter Server License" 23 | ``` 24 | 25 | This example shows how to add a license key to SDDC Manager. 26 | 27 | ## Parameters 28 | 29 | ### -key 30 | 31 | Specifies the license key to add. 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 | ### -productType 46 | 47 | Specifies the product type for the license key. One of: SDDC_MANAGER, VCENTER, VSAN, ESXI, NSXT, WCP. 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 | ### -description 62 | 63 | Specifies the description for the license key. 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/licenses/Remove-VCFLicenseKey.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFLicenseKey 2 | 3 | ## Synopsis 4 | 5 | Removes a license key. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFLicenseKey [-key] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFLicenseKey` cmdlet removes a license key from SDDC Manager. 16 | 17 | ???+ info 18 | 19 | A license key can only be removed if the key is not in use. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Remove-VCFLicenseKey -key "AAAAA-AAAAA-AAAAA-AAAAA-AAAAA" 27 | ``` 28 | 29 | This example shows how to remove a license key. 30 | 31 | ## Parameters 32 | 33 | ### -key 34 | 35 | Specifies the license key to remove. 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 | ### Common Parameters 50 | 51 | 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). 52 | -------------------------------------------------------------------------------- /docs/documentation/functions/network-pools/Get-VCFNetworkIPPool.md: -------------------------------------------------------------------------------- 1 | # Get-VCFNetworkIPPool 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of all networks of a network pool. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFNetworkIPPool [-id] [[-networkId] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFNetworkIPPool` cmdlet retrieves a list of all networks of a network pool. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFNetworkIPPool -id 917bcf8f-93e8-4b84-9627-471899c05f52 23 | ``` 24 | 25 | This example shows how to retrieve a list of all networks of a network pool by unique ID. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFNetworkIPPool -id 917bcf8f-93e8-4b84-9627-471899c05f52 -networkId c2197368-5b7c-4003-80e5-ff9d3caef795 31 | ``` 32 | 33 | This example shows how to retrieve a list of details for a specific network associated to the network pool using the unique ID of the network pool and the unique ID of the network. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the network pool. 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 | ### -networkId 54 | 55 | Specifies the unique ID of the network. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: False 63 | Position: 2 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### Common Parameters 70 | 71 | 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). 72 | -------------------------------------------------------------------------------- /docs/documentation/functions/network-pools/Get-VCFNetworkPool.md: -------------------------------------------------------------------------------- 1 | # Get-VCFNetworkPool 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of all network pools. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFNetworkPool [[-name] ] [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFNetworkPool` cmdlet retrieves a list of all network pools. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFNetworkPool 23 | ``` 24 | 25 | This example shows how to retrieve a list of all network pools. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFNetworkPool -name sfo01-networkpool 31 | ``` 32 | 33 | This example shows how to retrieve a network pool by name. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFNetworkPool -id 40b0b36d-36d6-454c-814b-ba8bf9b383e3 39 | ``` 40 | 41 | This example shows how to retrieve a network pool by unique ID. 42 | 43 | ## Parameters 44 | 45 | ### -name 46 | 47 | Specifies the name of the network pool. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: False 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -id 62 | 63 | Specifies the unique ID of the network pool. 64 | 65 | ```yaml 66 | Type: String 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: 2 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/network-pools/New-VCFNetworkPool.md: -------------------------------------------------------------------------------- 1 | # New-VCFNetworkPool 2 | 3 | ## Synopsis 4 | 5 | Adds a network pool. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFNetworkPool [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFNetworkPool` cmdlet adds a network pool. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFNetworkPool -json (Get-Content -Raw .\samples\network-pools\networkPoolSpec.json) 23 | ``` 24 | 25 | This example shows how to add a network pool using a JSON specification file. 26 | 27 | ???+ example "Sample JSON: Add Network Pool" 28 | 29 | ```json 30 | --8<-- "./samples/network-pools/networkPoolSpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### Common Parameters 52 | 53 | 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). 54 | -------------------------------------------------------------------------------- /docs/documentation/functions/network-pools/Remove-VCFNetworkPool.md: -------------------------------------------------------------------------------- 1 | # Remove-VCFNetworkPool 2 | 3 | ## Synopsis 4 | 5 | Removes a network pool. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Remove-VCFNetworkPool [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Remove-VCFNetworkPool` cmdlet removes a network pool. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Remove-VCFNetworkPool -id 7ee7c7d2-5251-4bc9-9f91-4ee8d911511f 23 | ``` 24 | 25 | This example shows how to remove a network pool by unique ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the network pool. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/nsx/nsx-edge-clusters/Get-VCFEdgeCluster.md: -------------------------------------------------------------------------------- 1 | # Get-VCFEdgeCluster 2 | 3 | ## Aliases 4 | 5 | `Get-NSXEdgeCluster` 6 | 7 | ## Synopsis 8 | 9 | Retrieves a list of NSX Edge clusters managed by SDDC Manager. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFEdgeCluster [[-id] ] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFEdgeCluster` cmdlet retrieves a list of NSX Edge clusters managed by SDDC Manager. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFEdgeCluster 27 | ``` 28 | 29 | This example shows how to retrieve the list of NSX Edge clusters managed by SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Get-VCFEdgeCluster -id b4e3b2c4-31e8-4816-b1c5-801e848bef09 35 | ``` 36 | 37 | This example shows how to retrieve an NSX Edge cluster managed by SDDC Manager by unique ID. 38 | 39 | ## Parameters 40 | 41 | ### -id 42 | 43 | Specifies the unique ID of the NSX Edge cluster. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: False 51 | Position: 1 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### Common Parameters 58 | 59 | 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). 60 | -------------------------------------------------------------------------------- /docs/documentation/functions/nsx/nsx-edge-clusters/New-VCFEdgeCluster.md: -------------------------------------------------------------------------------- 1 | # New-VCFEdgeCluster 2 | 3 | ## Aliases 4 | 5 | `New-NSXEdgeCluster` 6 | 7 | ## Synopsis 8 | 9 | Creates an NSX Edge cluster managed by SDDC Manager. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | New-VCFEdgeCluster [-json] [-validate] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `New-VCFEdgeCluster` cmdlet creates an NSX Edge cluster managed by SDDC Manager. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | New-VCFEdgeCluster -json (Get-Content -Raw .\samples\nsx\nsx-edge-clusters\edgeClusterSpec.json) 27 | ``` 28 | 29 | This example shows how to create an NSX Edge cluster using a JSON specification file. 30 | 31 | ???+ example "Sample JSON: NSX Edge cluster" 32 | 33 | ```json 34 | --8<-- "./samples/nsx/nsx-edge-clusters/edgeClusterSpec.json" 35 | ``` 36 | 37 | ### Example 2 38 | 39 | ```powershell 40 | New-VCFEdgeCluster -json (Get-Content -Raw .\samples\nsx\nsx-edge-clusters\edgeClusterSpec.json) -validate 41 | ``` 42 | 43 | This example shows how to validate the NSX Edge cluster JSON specification file. 44 | 45 | ## Parameters 46 | 47 | ### -json 48 | 49 | Specifies the JSON specification to be used. 50 | 51 | ```yaml 52 | Type: String 53 | Parameter Sets: (All) 54 | Aliases: 55 | 56 | Required: True 57 | Position: 1 58 | Default value: None 59 | Accept pipeline input: False 60 | Accept wildcard characters: False 61 | ``` 62 | 63 | ### -validate 64 | 65 | Specifies to validate the JSON specification file. 66 | 67 | ```yaml 68 | Type: SwitchParameter 69 | Parameter Sets: (All) 70 | Aliases: 71 | 72 | Required: False 73 | Position: Named 74 | Default value: False 75 | Accept pipeline input: False 76 | Accept wildcard characters: False 77 | ``` 78 | 79 | ### Common Parameters 80 | 81 | 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). 82 | -------------------------------------------------------------------------------- /docs/documentation/functions/nsx/nsx-managers/Get-VCFNsxtCluster.md: -------------------------------------------------------------------------------- 1 | # Get-VCFNsxtCluster 2 | 3 | ## Aliases 4 | 5 | `Get-VCFNsxManagerCluster` 6 | 7 | ## Synopsis 8 | 9 | Retrieves a list of NSX Managers managed by SDDC Manager. 10 | 11 | ## Syntax 12 | 13 | ```powershell 14 | Get-VCFNsxtCluster [[-id] ] [] 15 | ``` 16 | 17 | ## Description 18 | 19 | The `Get-VCFNsxtCluster` cmdlet retrieves a list of NSX Manager clusters managed by SDDC Manager. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFNsxtCluster 27 | ``` 28 | 29 | This example shows how to retrieve the list of NSX Manager clusters managed by SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Get-VCFNsxtCluster -id d189a789-dbf2-46c0-a2de-107cde9f7d24 35 | ``` 36 | 37 | This example shows how to retrieve the NSX Manager cluster managed by SDDC Manager by unique ID. 38 | 39 | ### Example 3 40 | 41 | ```powershell 42 | Get-VCFNsxtCluster | Select vipfqdn 43 | ``` 44 | 45 | This example shows how to retrieve the NSX Manager clusters managed by SDDC Manager and select the VIP FQDN. 46 | 47 | ## Parameters 48 | 49 | ### -id 50 | 51 | Specifies the unique ID of the NSX Manager cluster. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: False 59 | Position: 1 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### Common Parameters 66 | 67 | 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). 68 | -------------------------------------------------------------------------------- /docs/documentation/functions/personalities/Get-VCFPersonality.md: -------------------------------------------------------------------------------- 1 | # Get-VCFPersonality 2 | 3 | ## Synopsis 4 | 5 | Retrieves the vSphere Lifecycle Manager personalities. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFPersonality [[-id] ] [[-name] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFPersonality` cmdlet gets the vSphere Lifecycle Manager personalities which are available via depot access. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFPersonality 23 | ``` 24 | 25 | This example shows how to retrieve a list of all vSphere Lifecycle Manager personalities availble in the depot. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFPersonality -id b4e3b2c4-31e8-4816-b1c5-801e848bef09 31 | ``` 32 | 33 | This example shows how to retrieve a vSphere Lifecycle Manager personality by unique ID. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFPersonality -name vSphere-8.0U1 39 | ``` 40 | 41 | This example shows how to retrieve a vSphere Lifecycle Manager personality by unique name. 42 | 43 | 44 | ## Parameters 45 | 46 | ### -id 47 | 48 | Specifies the unique ID of the vSphere Lifecycle Manager personality. 49 | 50 | ```yaml 51 | Type: String 52 | Parameter Sets: (All) 53 | Aliases: 54 | 55 | Required: False 56 | Position: 1 57 | Default value: None 58 | Accept pipeline input: False 59 | Accept wildcard characters: False 60 | ``` 61 | 62 | ### -name 63 | 64 | Specifies the unique name of the vSphere Lifecycle Manager personality. 65 | 66 | ```yaml 67 | Type: String 68 | Parameter Sets: (All) 69 | Aliases: 70 | 71 | Required: False 72 | Position: 2 73 | Default value: None 74 | Accept pipeline input: False 75 | Accept wildcard characters: False 76 | ``` 77 | 78 | ### Common Parameters 79 | 80 | 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). 81 | -------------------------------------------------------------------------------- /docs/documentation/functions/personalities/New-VCFPersonality.md: -------------------------------------------------------------------------------- 1 | # New-VCFPersonality 2 | 3 | ## Synopsis 4 | 5 | Adds a vSphere Lifecycle Manager personality/image in the SDDC Manager inventory from an existing vLCM image based cluster. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | New-VCFPersonality [-name] [-vCenterId] [-clusterId] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `New-VCFPersonality` creates a new vSphere Lifecycle Manager personalities/image in the SDDC Manager inventory from an existing vLCM cluster. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | New-VCFPersonality -name "vSphere 8.0U1" -vCenterId 6c7c3aaa-79cb-42fd-ade3-353f682cb1dc -clusterId "domain-c44" 23 | ``` 24 | 25 | This example shows how to add a new vSphere Lifecycle Manager personality/image in the SDDC Manager inventory from an existing vLCM image based cluster. 26 | 27 | ## Parameters 28 | 29 | ### -name 30 | 31 | Specifies the image name. 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 | ### -vCenterId 46 | 47 | Specifies the unique ID of the vCenter Server from which the cluster image will be imported. 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 | ### -clusterId 62 | 63 | Specifies the unique ID of the vSphere cluster from which the image will be imported. Can be the vSphere MOID or cluster ID in 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/proxy/Get-VCFProxy.md: -------------------------------------------------------------------------------- 1 | # Get-VCFProxy 2 | 3 | ## Synopsis 4 | 5 | Gets the proxy configuration for the SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFProxy 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFProxy` cmdlet retrieves the proxy configuration of the SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFProxy 23 | ``` 24 | 25 | This example shows how to get the proxy configuration of the SDDC Manager. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/proxy/Set-VCFProxy.md: -------------------------------------------------------------------------------- 1 | # Set-VCFProxy 2 | 3 | ## Synopsis 4 | 5 | Sets the proxy configuration for the SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Set-VCFProxy -status [-proxyHost ] [-proxyPort ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Set-VCFProxy` cmdlet sets the proxy configuration of the SDDC Manager. 16 | 17 | ???+ note 18 | 19 | This cmdlet will not clear the proxy configuration. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Set-VCFProxy -status ENABLED -proxyHost proxy.rainpole.io -proxyPort 3128 27 | ``` 28 | 29 | This example shows how to enable the proxy configuration of the SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Set-VCFProxy -status DISABLED 35 | ``` 36 | 37 | This example shows how to disable the proxy configuration of the SDDC Manager. 38 | 39 | ## Parameters 40 | 41 | ### -status 42 | 43 | Enable or disable the proxy configuration. 44 | 45 | ```yaml 46 | Type: String 47 | Parameter Sets: (All) 48 | Aliases: 49 | 50 | Required: True 51 | Position: Named 52 | Default value: None 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -proxyHost 58 | 59 | The fully qualified domain name or IP address of the proxy. 60 | 61 | ```yaml 62 | Type: String 63 | Parameter Sets: (All) 64 | Aliases: 65 | 66 | Required: False 67 | Position: Named 68 | Default value: None 69 | Accept pipeline input: False 70 | Accept wildcard characters: False 71 | ``` 72 | 73 | ### -proxyPort 74 | 75 | The port number of the proxy. 76 | 77 | ```yaml 78 | Type: Int32 79 | Parameter Sets: (All) 80 | Aliases: 81 | 82 | Required: False 83 | Position: Named 84 | Default value: 0 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### Common Parameters 90 | 91 | This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_Common Parameters](http://go.microsoft.com/fwlink/?LinkID=113216). 92 | -------------------------------------------------------------------------------- /docs/documentation/functions/pscs/Get-VCFPSC.md: -------------------------------------------------------------------------------- 1 | # Get-VCFPSC 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of Platform Services Controllers. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFPSC [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFPSC` cmdlet retrieves a list of all Platform Services Controllers. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFPSC 23 | ``` 24 | 25 | This example shows how to retrieve a list of all Platform Services Controllers. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFPSC -id b4e3b2c4-31e8-4816-b1c5-801e848bef09 31 | ``` 32 | 33 | This example shows how to retrieve a Platform Services Controller by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the Platform Services Controller. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Get-CloudBuilderSDDC.md: -------------------------------------------------------------------------------- 1 | # Get-CloudBuilderSDDC 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of management domain deployment from VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-CloudBuilderSDDC [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-CloudBuilderSDDC` cmdlet retrieves a list of all SDDC deployments from VMware Cloud Builder. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-CloudBuilderSDDC 23 | ``` 24 | 25 | This example shows how to retrieve a list of all SDDC deployments from VMware Cloud Builder. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-CloudBuilderSDDC -id 51cc2d90-13b9-4b62-b443-c1d7c3be0c23 31 | ``` 32 | 33 | This example shows how to retrieve a SDDC deployment from VMware Cloud Builder by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the management domain deployment task. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Get-CloudBuilderSDDCValidation.md: -------------------------------------------------------------------------------- 1 | # Get-CloudBuilderSDDCValidation 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of management domain validations tasks from VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-CloudBuilderSDDCValidation [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-CloudBuilderSDDCValidation` cmdlet retrieves a list of all SDDC validations from VMware Cloud Builder. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-CloudBuilderSDDCValidation 23 | ``` 24 | 25 | This example shows how to retrieve a list of all SDDC validations from VMware Cloud Builder. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-CloudBuilderSDDCValidation -id 1ff80635-b878-441a-9e23-9369e1f6e5a3 31 | ``` 32 | 33 | This example shows how to retrieve a SDDC validation from VMware Cloud Builder by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the management domain validation task. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Restart-CloudBuilderSDDC.md: -------------------------------------------------------------------------------- 1 | # Restart-CloudBuilderSDDC 2 | 3 | ## Synopsis 4 | 5 | Retry a failed management domain deployment task on VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Restart-CloudBuilderSDDC [-id] [[-json] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Restart-CloudBuilderSDDC` cmdlet retries a failed management domain deployment task on VMware Cloud Builder. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Restart-CloudBuilderSDDC -id bedf19f8-9dfe-4c60-aae4-bca986a65a31 23 | ``` 24 | 25 | This example shows how to retry a deployment on VMware Cloud Builder based on the ID. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Restart-CloudBuilderSDDC -id bedf19f8-9dfe-4c60-aae4-bca986a65a31 -json .\samples\SDDC\SddcSpec.json 31 | ``` 32 | 33 | This example shows how to retry a deployment on VMware Cloud Builder based on the ID and an updated JSON specification file. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the management domain deployment task. 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 | ### -json 54 | 55 | Specifies the JSON specification to be used. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: False 63 | Position: 2 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### Common Parameters 70 | 71 | 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). 72 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Restart-CloudBuilderSDDCValidation.md: -------------------------------------------------------------------------------- 1 | # Restart-CloudBuilderSDDCValidation 2 | 3 | ## Synopsis 4 | 5 | Retry a failed management domain validation task on VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Restart-CloudBuilderSDDCValidation [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Restart-CloudBuilderSDDCValidation` cmdlet retries a failed management domain validation task on VMware Cloud Builder. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Restart-CloudBuilderSDDCValidation -id bedf19f8-9dfe-4c60-aae4-bca986a65a31 23 | ``` 24 | 25 | This example shows how to retry a validation on VMware Cloud Builder based on the ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the management domain validation task 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Start-CloudBuilderSDDC.md: -------------------------------------------------------------------------------- 1 | # Start-CloudBuilderSDDC 2 | 3 | ## Synopsis 4 | 5 | Starts a management domain deployment task on VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-CloudBuilderSDDC [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-CloudBuilderSDDC` cmdlet starts a management domain deployment task on VMware Cloud Builder using a JSON specification file. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-CloudBuilderSDDC -json .\samples\sddc\sddcSpec.json 23 | ``` 24 | 25 | This example shows how to start a management domain deployment task on VMware Cloud Builder using a JSON specification file. 26 | 27 | ???+ example "Sample JSON: Management Domain Bringup" 28 | 29 | ```json 30 | --8<-- "./samples/sddc/sddcSpec.json" 31 | ``` 32 | 33 | ???+ example "Sample JSON: Multi-pNIC Management Domain Bringup" 34 | 35 | ```json 36 | --8<-- "./samples/sddc/multiPnicSddcSpec.json" 37 | ``` 38 | 39 | ## Parameters 40 | 41 | ### -json 42 | 43 | Specifies the JSON specification to be used. 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 | ### Common Parameters 58 | 59 | 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). 60 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Start-CloudBuilderSDDCValidation.md: -------------------------------------------------------------------------------- 1 | # Start-CloudBuilderSDDCValidation 2 | 3 | ## Synopsis 4 | 5 | Start the validation of a management domain JSON specification file on VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-CloudBuilderSDDCValidation [-json] [[-validation] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-CloudBuilderSDDCValidation` cmdlet starts the validation of a management domain JSON specification file on VMware Cloud Builder. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-CloudBuilderSDDCValidation -json .\samples\SDDC\SddcSpec.json 23 | ``` 24 | 25 | This example shows how to start the validation of a management domain JSON specification file on VMware Cloud Builder. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Start-CloudBuilderSDDCValidation -json .\samples\SDDC\SddcSpec.json -validation LICENSE_KEY_VALIDATION 31 | ``` 32 | 33 | This example shows how to start the validation of a specific item in a management domain JSON specification file on VMware Cloud Builder. 34 | 35 | ## Parameters 36 | 37 | ### -json 38 | 39 | Specifies the JSON specification to be used. 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 | ### -validation 54 | 55 | Specifies the validation to be performed. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: False 63 | Position: 2 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### Common Parameters 70 | 71 | 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). 72 | -------------------------------------------------------------------------------- /docs/documentation/functions/sddc/Stop-CloudBuilderSDDCValidation.md: -------------------------------------------------------------------------------- 1 | # Stop-CloudBuilderSDDCValidation 2 | 3 | ## Synopsis 4 | 5 | Stop the in-progress validation of a management domain JSON specification file on VMware Cloud Builder. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Stop-CloudBuilderSDDCValidation [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Stop-CloudBuilderSDDCValidation` cmdlet stops the in-progress validation of a management domain JSON specification file on VMware Cloud Builder. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Stop-CloudBuilderSDDCValidation -id bedf19f8-9dfe-4c60-aae4-bca986a65a31 23 | ``` 24 | 25 | This example shows how to stop a validation on VMware Cloud Builder based on the ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the management domain validation task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/services/Get-VCFService.md: -------------------------------------------------------------------------------- 1 | # Get-VCFService 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of services running on SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFService [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFService` cmdlet retrieves the list of services running on SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFService 23 | ``` 24 | 25 | This example shows how to retrieve a list of all services running on SDDC Manager. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFService -id 4e416419-fb82-409c-ae37-32a60ba2cf88 31 | ``` 32 | 33 | This example shows how to return the details for a specific service running on SDDC Manager by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifics the unique ID of the service running on SDDC Manager. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/sos/Get-VCFHealthSummaryTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFHealthSummaryTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves the Health Summary tasks. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFHealthSummaryTask [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFHealthSummaryTask` cmdlet retrieves the Health Summary tasks. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFHealthSummaryTask 23 | ``` 24 | 25 | This example shows how to retrieve the Health Summary tasks. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFHealthSummaryTask -id 31 | ``` 32 | 33 | This example shows how to retrieve the Health Summary task by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the Health Summary task. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/sos/Get-VCFSupportBundleTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFSupportBundleTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves the support bundle tasks. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFSupportBundleTask [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFSupportBundleTask` cmdlet retrieves the support bundle tasks. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFSupportBundleTask 23 | ``` 24 | 25 | This example shows how to retrieve the support bundle tasks. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | ``` 31 | 32 | This example shows how to retrieve the support bundle tasks based on the unique ID. 33 | 34 | ## Parameters 35 | 36 | ### -id 37 | 38 | Specifies the unique ID of the support bundle task. 39 | 40 | ```yaml 41 | Type: String 42 | Parameter Sets: (All) 43 | Aliases: 44 | 45 | Required: False 46 | Position: 1 47 | Default value: None 48 | Accept pipeline input: False 49 | Accept wildcard characters: False 50 | ``` 51 | 52 | ### Common Parameters 53 | 54 | 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). 55 | -------------------------------------------------------------------------------- /docs/documentation/functions/sos/Request-VCFHealthSummaryBundle.md: -------------------------------------------------------------------------------- 1 | # Request-VCFHealthSummaryBundle 2 | 3 | ## Synopsis 4 | 5 | Downloads the Health Summary bundle. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VCFHealthSummaryBundle [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VCFHealthSummaryBundle` cmdlet downloads the Health Summary bundle. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Request-VCFHealthSummaryBundle -id 12345678-1234-1234-1234-123456789012 23 | ``` 24 | 25 | This example shows how to download a Health Summary bundle. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the Health Summary task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/sos/Request-VCFSupportBundle.md: -------------------------------------------------------------------------------- 1 | # Request-VCFSupportBundle 2 | 3 | ## Synopsis 4 | 5 | Downloads the support bundle. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VCFSupportBundle [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VCFSupportBundle` cmdlet downloads the support bundle. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Request-VCFSupportBundle -id 12345678-1234-1234-1234-123456789012 23 | ``` 24 | 25 | This example shows how to download the support bundle by unique ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the support bundle task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/sos/Start-VCFHealthSummary.md: -------------------------------------------------------------------------------- 1 | # Start-VCFHealthSummary 2 | 3 | ## Synopsis 4 | 5 | Starts the Health Summary checks. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFHealthSummary [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFHealthSummary` cmdlet starts the Health Summary checks. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-VCFHealthSummary -json (Get-Content -Raw .\samples\sos\healthSummarySpec.json) 23 | ``` 24 | 25 | This example shows how to start the Health Summary checks using the JSON specification file. 26 | 27 | ???+ example "Sample JSON: Start Health Summary" 28 | 29 | ```json 30 | --8<-- "./samples/sos/healthSummarySpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### Common Parameters 52 | 53 | 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). 54 | -------------------------------------------------------------------------------- /docs/documentation/functions/sos/Start-VCFSupportBundle.md: -------------------------------------------------------------------------------- 1 | # Start-VCFSupportBundle 2 | 3 | ## Synopsis 4 | 5 | Starts the support bundle generation. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFSupportBundle [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFSupportBundle` cmdlet starts the support bundle generation. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-VCFSupportBundle -json (Get-Content -Raw .\samples\sos\supportBundleSpec.json) 23 | ``` 24 | 25 | This example shows how to start the support bundle generation using a JSON specification file. 26 | 27 | ???+ example "Sample JSON: Support Bundle Generation" 28 | 29 | ```json 30 | --8<-- "./samples/sos/supportBundleSpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### Common Parameters 52 | 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). 53 | -------------------------------------------------------------------------------- /docs/documentation/functions/system-prechecks/Get-VCFSystemPrecheckTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFSystemPrecheckTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves the status of a system level precheck task. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFSystemPrecheckTask [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFSystemPrecheckTask` cmdlet retrieves the status of a system level precheck task that can be polled and monitored. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFSystemPrecheckTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d 23 | ``` 24 | 25 | This example shows how to retrieve the status of a system level precheck task by unique ID. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFSystemPrecheckTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d -failureOnly 31 | ``` 32 | 33 | This example shows how to retrieve only failed subtasks from the system level precheck task by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the system level precheck task. 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 | ### -failureOnly 53 | 54 | Specifies to return only the failed subtasks. 55 | 56 | ```yaml 57 | Type: Switch 58 | Parameter Sets: (All) 59 | Aliases: 60 | 61 | Required: False 62 | Position: 2 63 | Default value: None 64 | Accept pipeline input: False 65 | Accept wildcard characters: False 66 | ``` 67 | ### Common Parameters 68 | 69 | 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). 70 | -------------------------------------------------------------------------------- /docs/documentation/functions/system-prechecks/Start-VCFSystemPrecheck.md: -------------------------------------------------------------------------------- 1 | # Start-VCFSystemPrecheck 2 | 3 | ## Synopsis 4 | 5 | Starts the system level health check. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFSystemPrecheck [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFSystemPrecheck` cmdlet performs system level health checks and upgrade pre-checks. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-VCFSystemPrecheck -json (Get-Content -Raw .\samples\system-prechecks\precheckSpec.json) 23 | ``` 24 | 25 | This example shows how to perform system level health checks and upgrade pre-checks using the JSON specification file. 26 | 27 | ???+ example "Sample JSON: System Prechecks" 28 | 29 | ```json 30 | --8<-- "./samples/system-prechecks/precheckSpec.json" 31 | ``` 32 | 33 | ## Parameters 34 | 35 | ### -json 36 | 37 | Specifies the JSON specification to be used. 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 | ### Common Parameters 52 | 53 | 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). 54 | -------------------------------------------------------------------------------- /docs/documentation/functions/tasks/Get-VCFTask.md: -------------------------------------------------------------------------------- 1 | # Get-VCFTask 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of tasks. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFTask [[-id] ] [[-status] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFTask` cmdlet retrieves a list of tasks from the SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFTask 23 | ``` 24 | 25 | This example shows how to retrieve all tasks. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFTask -id 7e1c2eee-3177-4e3b-84db-bfebc83f386a 31 | ``` 32 | 33 | This example shows how to retrieve a task by unique ID. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFTask -status SUCCESSFUL 39 | ``` 40 | 41 | This example shows how to retrieve all tasks with a specific status. 42 | 43 | ## Parameters 44 | 45 | ### -id 46 | 47 | Specifies the unique ID of the task to retrieve. 48 | 49 | ```yaml 50 | Type: String 51 | Parameter Sets: (All) 52 | Aliases: 53 | 54 | Required: False 55 | Position: 1 56 | Default value: None 57 | Accept pipeline input: False 58 | Accept wildcard characters: False 59 | ``` 60 | 61 | ### -status 62 | 63 | Specifies the status of the task to retrieve. One of: SUCCESSFUL, FAILED. 64 | 65 | ```yaml 66 | Type: String 67 | Parameter Sets: (All) 68 | Aliases: 69 | 70 | Required: False 71 | Position: 2 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/tasks/Restart-VCFTask.md: -------------------------------------------------------------------------------- 1 | # Restart-VCFTask 2 | 3 | ## Synopsis 4 | 5 | Retries a previously failed task. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Restart-VCFTask [-id] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Restart-VCFTask` cmdlet retries a previously failed task based on the unique ID of the task. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Restart-VCFTask -id 7e1c2eee-3177-4e3b-84db-bfebc83f386a 23 | ``` 24 | 25 | This example shows how to restart a task by unique ID. 26 | 27 | ## Parameters 28 | 29 | ### -id 30 | 31 | Specifies the unique ID of the task. 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 | ### Common Parameters 46 | 47 | 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). 48 | -------------------------------------------------------------------------------- /docs/documentation/functions/upgrades/Get-VCFUpgradable.md: -------------------------------------------------------------------------------- 1 | # Get-VCFUpgradable 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of upgradables. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFUpgradable 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFUpgradable` cmdlet retrieves a list of upgradables from SDDC Manager. 16 | 17 | ???+ info 18 | 19 | The information returned by this cmdlet can used for both the precheck and upgrade cmdlets. 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Get-VCFUpgradable 27 | ``` 28 | 29 | This example shows how to retrieve the list of upgradables from SDDC Manager. 30 | -------------------------------------------------------------------------------- /docs/documentation/functions/upgrades/Get-VCFUpgrade.md: -------------------------------------------------------------------------------- 1 | # Get-VCFUpgrade 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of upgradable resources. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFUpgrade [[-id] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFUpgrade` cmdlet retrieves a list of upgradable resources from SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFUpgrade 23 | ``` 24 | 25 | This example shows how to retrieve a list of upgradable resources from SDDC Manager. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFUpgrade -id 7e1c2eee-3177-4e3b-84db-bfebc83f386a 31 | ``` 32 | 33 | This example shows how to retrieve an upgradable resource by unique ID. 34 | 35 | ## Parameters 36 | 37 | ### -id 38 | 39 | Specifies the unique ID of the upgradable resource to retrieve. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 1 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### Common Parameters 54 | 55 | 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). 56 | -------------------------------------------------------------------------------- /docs/documentation/functions/upgrades/Start-VCFUpgrade.md: -------------------------------------------------------------------------------- 1 | # Start-VCFUpgrade 2 | 3 | ## Synopsis 4 | 5 | Starts the upgrade of a resource. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-VCFUpgrade [-json] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-VCFUpgrade` cmdlet starts the upgrade of a resource in SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | 22 | ```powershell 23 | Start-VCFUpgrade -json (Get-Content -Raw .\samples\upgrades\upgradeDomainSpec.json) 24 | ``` 25 | 26 | This example shows how to start an upgrade in SDDC Manager by using a JSON specification file. 27 | 28 | ???+ example "Sample JSON: Domain Upgrade" 29 | 30 | ```json 31 | --8<-- "./samples/upgrades/upgradeDomainSpec.json" 32 | ``` 33 | 34 | ## Parameters 35 | 36 | ### -json 37 | 38 | Specifies the JSON specification to be used. 39 | 40 | ```yaml 41 | Type: String 42 | Parameter Sets: (All) 43 | Aliases: 44 | 45 | Required: True 46 | Position: 1 47 | Default value: None 48 | Accept pipeline input: False 49 | Accept wildcard characters: False 50 | ``` 51 | 52 | ### Common Parameters 53 | 54 | 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). 55 | -------------------------------------------------------------------------------- /docs/documentation/functions/vcenters/Get-VCFvCenter.md: -------------------------------------------------------------------------------- 1 | # Get-VCFvCenter 2 | 3 | ## Synopsis 4 | 5 | Retrieves a list of vCenter Servers instances managed by SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Get-VCFvCenter [[-id] ] [[-domainId] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Get-VCFvCenter` cmdlet retrieves a list of vCenter Servers instances managed by SDDC Manager. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Get-VCFvCenter 23 | ``` 24 | 25 | This example shows how to retrieve a list of all vCenter Server instances managed by SDDC Manager. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Get-VCFvCenter -id d189a789-dbf2-46c0-a2de-107cde9f7d24 31 | ``` 32 | 33 | This example shows how to return the details of a vCenter Server instance managed by SDDC Manager by its unique ID. 34 | 35 | ### Example 3 36 | 37 | ```powershell 38 | Get-VCFvCenter -domain 1a6291f2-ed54-4088-910f-ead57b9f9902 39 | ``` 40 | 41 | This example shows how to return the details of a vCenter Server instance managed by SDDC Manager by unique ID of its workload domain. 42 | 43 | ### Example 4 44 | 45 | ```powershell 46 | Get-VCFvCenter | select fqdn 47 | ``` 48 | 49 | This example shows how to retrieve a list of all vCenter Servers managed by SDDC Manager and display only their FQDN. 50 | 51 | ## Parameters 52 | 53 | ### -id 54 | 55 | Specifies the unique ID of the vCenter Server instance. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: False 63 | Position: 1 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -domainId 70 | 71 | Specifies the unique ID of the workload domain. 72 | 73 | ```yaml 74 | Type: String 75 | Parameter Sets: (All) 76 | Aliases: 77 | 78 | Required: False 79 | Position: 2 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### Common Parameters 86 | 87 | 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). 88 | -------------------------------------------------------------------------------- /docs/documentation/getting-started/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 | -------------------------------------------------------------------------------- /docs/documentation/getting-started/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 | -------------------------------------------------------------------------------- /docs/documentation/index.md: -------------------------------------------------------------------------------- 1 | --8<-- "./docs/documentation/getting-started/usage.md" 2 | -------------------------------------------------------------------------------- /docs/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation/cd24a1123537c5bbb645955c2fce31b3a9425405/docs/favicon.ico -------------------------------------------------------------------------------- /docs/license.md: -------------------------------------------------------------------------------- 1 | --8<-- "./LICENSE" 2 | -------------------------------------------------------------------------------- /docs/release-notes.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CHANGELOG.md" 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/copy-module-local-linux.sh: -------------------------------------------------------------------------------- 1 | scp -r /home/modules/* username@remote_host:/home/lab/.local/share/powershell/Modules/ -------------------------------------------------------------------------------- /docs/snippets/copy-module-local-windows.ps1: -------------------------------------------------------------------------------- 1 | Copy-Item -Path F:\Module\* -Destination '\\\C$\Program Files\WindowsPowerShell\Modules\' -Recurse -------------------------------------------------------------------------------- /docs/snippets/import-module-local-linux.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name PowerVCF 3 | -------------------------------------------------------------------------------- /docs/snippets/import-module.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name PowerVCF 3 | -------------------------------------------------------------------------------- /docs/snippets/install-module.ps1: -------------------------------------------------------------------------------- 1 | Set-PSRepository -Name PSGallery -InstallationPolicy Trusted 2 | Install-Module -Name VMware.PowerCLI -MinimumVersion 12.3.0 -Repository PSGallery 3 | Install-Module -Name PowerVCF -Repository PSGallery 4 | -------------------------------------------------------------------------------- /docs/snippets/installed-module.ps1: -------------------------------------------------------------------------------- 1 | Get-InstalledModule -Name PowerVCF 2 | -------------------------------------------------------------------------------- /docs/snippets/pre-req-linux.sh: -------------------------------------------------------------------------------- 1 | mkdir /home/modules -------------------------------------------------------------------------------- /docs/snippets/save-module-local-linux.ps1: -------------------------------------------------------------------------------- 1 | Save-Module -Name VMware.PowerCLI -Path /home/modules -Repository PSGallery 2 | Save-Module -Name PowerVCF -Path /home/modules -Repository PSGallery -------------------------------------------------------------------------------- /docs/snippets/save-module-local-windows.ps1: -------------------------------------------------------------------------------- 1 | Save-Module -Name VMware.PowerCLI -Path F:\Module\ -Repository PSGallery 2 | Save-Module -Name PowerVCF -Path F:\Module\ -Repository PSGallery 3 | -------------------------------------------------------------------------------- /docs/snippets/update-module.ps1: -------------------------------------------------------------------------------- 1 | Update-Module -Name PowerVCF 2 | -------------------------------------------------------------------------------- /samples/aria-suite/aria-lifecycle/deployAriaLifecycleAvnOverlaySpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "apiPassword": "VMw@re1!", 3 | "fqdn": "xint-vrslcm01.rainpole.io", 4 | "nsxtStandaloneTier1Ip": "192.168.11.2", 5 | "sshPassword": "VMw@re1!" 6 | } 7 | -------------------------------------------------------------------------------- /samples/aria-suite/aria-lifecycle/deployAriaLifecycleAvnVlanSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "apiPassword": "VMw@re1!", 3 | "fqdn": "xint-vrslcm01.rainpole.io", 4 | "networkSpec": { 5 | "gateway": "172.16.225.1", 6 | "subnetMask": "255.255.255.0", 7 | "vlanId": "2225" 8 | }, 9 | "sshPassword": "VMw@re1!" 10 | } 11 | -------------------------------------------------------------------------------- /samples/avns/avnOverlaySpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "edgeClusterId": "7d091d76-af11-4cb8-a562-368e7f0367cc", 3 | "avns": [ 4 | { 5 | "name": "xint-m01-seg01", 6 | "regionType": "X_REGION", 7 | "gateway": "192.168.11.1", 8 | "subnet": "192.168.11.0", 9 | "subnetMask": "255.255.255.0", 10 | "mtu": 9000, 11 | "routerName": "sfo-m01-ec01-t1-gw01", 12 | "portGroupName": "xint-m01-seg01" 13 | }, 14 | { 15 | "name": "sfo-m01-seg01", 16 | "regionType": "REGION_A", 17 | "gateway": "192.168.31.1", 18 | "subnet": "192.168.31.0", 19 | "subnetMask": "255.255.255.0", 20 | "mtu": 9000, 21 | "routerName": "sfo-m01-ec01-t1-gw01", 22 | "portGroupName": "sfo-m01-seg01" 23 | } 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /samples/avns/avnVlanSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "edgeClusterId": "083741ad-6d64-4ea0-8117-ea940ca238d7", 3 | "avns": [ 4 | { 5 | "name": "xreg-m01-seg01", 6 | "regionType": "X_REGION", 7 | "gateway": "192.168.11.1", 8 | "subnet": "192.168.11.0", 9 | "subnetMask": "255.255.255.0", 10 | "mtu": 9000, 11 | "vlanId": 2021, 12 | "portGroupName": "xreg-m01-seg01" 13 | }, 14 | { 15 | "name": "sfo-m01-seg01", 16 | "regionType": "REGION_A", 17 | "subnet": "192.168.31.0", 18 | "gateway": "192.168.31.1", 19 | "subnetMask": "255.255.255.0", 20 | "mtu": 9000, 21 | "vlanId": 2022, 22 | "portGroupName": "sfo-m01-seg01" 23 | } 24 | ] 25 | } -------------------------------------------------------------------------------- /samples/backup-restore/backupSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "backupLocations": [ { 3 | "directoryPath": "/backups/sfo-vcf-01/", 4 | "password": "VMw@re1!", 5 | "port": 22, 6 | "protocol": "SFTP", 7 | "server": "secure.rainpole.io", 8 | "sshFingerprint": "", 9 | "username": "svc-vcf-bck" 10 | } ], 11 | "encryption": { 12 | "passphrase": "VMw@re1!VMw@re1!" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /samples/bundles/bundleUploadSpec.json: -------------------------------------------------------------------------------- 1 | 2 | { 3 | "bundleFilePath" : "/home/vcf/bundle_esxi/bundle-xxxxx.tar", 4 | "manifestFilePath" : "/home/vcf/bundle_esxi/bundle-xxxxx.manifest", 5 | "signatureFilePath" : "/home/vcf/bundle_esxi/bundle-xxxxx.manifest.sig" 6 | } 7 | 8 | -------------------------------------------------------------------------------- /samples/certificates/requestCertificateSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "caType": "Microsoft", 3 | "resources": [ 4 | { 5 | "fqdn": "sfo-w01-vc01.sfo.rainpole.io", 6 | "name": "sfo-w01-vc01", 7 | "resourceId": "56ec85d5-7276-4f81-ab93-bb3ce90e46a8", 8 | "type": "VCENTER" 9 | }, 10 | { 11 | "fqdn": "sfo-w01-nsx01.sfo.rainpole.io", 12 | "name": "sfo-w01-nsx01", 13 | "resourceId": "05efb755-6107-4bc2-bd3f-6d59a5c47ee2", 14 | "sans": [ 15 | "sfo-w01-nsx01a.sfo.rainpole.io", 16 | "sfo-w01-nsx01b.sfo.rainpole.io", 17 | "sfo-w01-nsx01c.sfo.rainpole.io", 18 | "sfo-w01-nsx01.sfo.rainpole.io" 19 | ], 20 | "type": "NSXT_MANAGER" 21 | } 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /samples/certificates/requestCsrSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "csrGenerationSpec": { 3 | "country": "US", 4 | "email": "support@rainpole.io", 5 | "keyAlgorithm": "RSA", 6 | "keySize": "2048", 7 | "locality": "San Francisco", 8 | "organization": "Rainpole", 9 | "organizationUnit": "Platform Engineering", 10 | "state": "CA" 11 | }, 12 | "resources": [ 13 | { 14 | "fqdn": "sfo-w01-vc01.sfo.rainpole.io", 15 | "name": "sfo-w01-vc01", 16 | "resourceId": "56ec85d5-7276-4f81-ab93-bb3ce90e46a8", 17 | "type": "VCENTER" 18 | }, 19 | { 20 | "fqdn": "sfo-w01-nsx01.sfo.rainpole.io", 21 | "name": "sfo-w01-nsx01", 22 | "resourceId": "05efb755-6107-4bc2-bd3f-6d59a5c47ee2", 23 | "sans": [ 24 | "sfo-w01-nsx01a.sfo.rainpole.io", 25 | "sfo-w01-nsx01b.sfo.rainpole.io", 26 | "sfo-w01-nsx01c.sfo.rainpole.io", 27 | "sfo-w01-nsx01.sfo.rainpole.io" 28 | ], 29 | "type": "NSXT_MANAGER" 30 | } 31 | ] 32 | } 33 | -------------------------------------------------------------------------------- /samples/certificates/updateCertificateSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "operationType": "INSTALL", 3 | "resources": [ 4 | { 5 | "fqdn": "sfo-w01-vc01.sfo.rainpole.io", 6 | "name": "sfo-w01-vc01", 7 | "resourceId": "56ec85d5-7276-4f81-ab93-bb3ce90e46a8", 8 | "type": "VCENTER" 9 | }, 10 | { 11 | "fqdn": "sfo-w01-nsx01.sfo.rainpole.io", 12 | "name": "sfo-w01-nsx01", 13 | "resourceId": "05efb755-6107-4bc2-bd3f-6d59a5c47ee2", 14 | "sans": [ 15 | "sfo-w01-nsx01a.sfo.rainpole.io", 16 | "sfo-w01-nsx01b.sfo.rainpole.io", 17 | "sfo-w01-nsx01c.sfo.rainpole.io", 18 | "sfo-w01-nsx01.sfo.rainpole.io" 19 | ], 20 | "type": "NSXT_MANAGER" 21 | } 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /samples/clusters/clusterCompactionSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "clusterCompactionSpec" : { 3 | "hosts" : [ { 4 | "id" : "4bd30f48-170a-4afa-a94d-725de3f745fd" 5 | } ] 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /samples/clusters/clusterExpansionSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "clusterExpansionSpec" : { 3 | "hostSpecs" : [ { 4 | "id" : "4bd30f48-170a-4afa-a94d-725de3f745fd" 5 | } ] 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /samples/credentials/rotateCredentialSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "operationType" : "ROTATE", 3 | "elements" : [ { 4 | "resourceName" : "sfo01-m01-esx01.sfo.rainpole.io", 5 | "resourceType" : "ESXI", 6 | "credentials" : [ { 7 | "credentialType" : "SSH", 8 | "username" : "root" 9 | } ] 10 | } ] 11 | } 12 | -------------------------------------------------------------------------------- /samples/credentials/updateCredentialSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "operationType" : "UPDATE", 3 | "elements" : [ { 4 | "resourceName" : "sfo01-m01-esx01.sfo.rainpole.io", 5 | "resourceType" : "ESXI", 6 | "credentials" : [ { 7 | "credentialType" : "SSH", 8 | "username" : "root", 9 | "password" : "VMw@re1!" 10 | } ] 11 | } ] 12 | } 13 | -------------------------------------------------------------------------------- /samples/dns-ntp/dnsSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "dnsServers": [ 3 | { 4 | "ipAddress": "172.16.11.4", 5 | "isPrimary": true 6 | }, 7 | { 8 | "ipAddress": "172.16.11.5", 9 | "isPrimary": false 10 | } 11 | ] 12 | } 13 | -------------------------------------------------------------------------------- /samples/dns-ntp/ntpSpec.json: -------------------------------------------------------------------------------- 1 | $ntpSpec = '{ 2 | "ntpServers": [ { 3 | "ipAddress": "ntp.sfo.rainpole.io" 4 | } ] 5 | }' -------------------------------------------------------------------------------- /samples/federation/federationSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "federationName" : "Rainpole", 3 | "memberJoinDetail" : { 4 | "role" : "CONTROLLER", 5 | "fqdn" : "sfo-vcf01.sfo.rainpole.io", 6 | "siteType" : "DATACENTER", 7 | "siteName" : "San Francisco", 8 | "country" : "USA", 9 | "state" : "CA", 10 | "city" : "San Francisco", 11 | "coordinate" : { 12 | "longitude" : -122.838, 13 | "latitude" : 37.286 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /samples/federation/joinFederationSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "controllerFqdn" : "sfo-vcf01.sfo.rainpole.io", 3 | "joinToken" : "522c566-836b-44c2-bf84-92dcc7e00764", 4 | "commonName" : "nyc-vcf01.nyc.rainpole.io", 5 | "memberJoinDetail" : { 6 | "role" : "MEMBER", 7 | "fqdn" : "nyc-vcf01.nyc.rainpole.io", 8 | "siteType" : "DATACENTER", 9 | "siteName" : "New York Epic Center", 10 | "country" : "USA", 11 | "state" : "New York", 12 | "city" : "New York", 13 | "coordinate" : { 14 | "longitude" : -74.006, 15 | "latitude" : 40.712 16 | } 17 | } 18 | } -------------------------------------------------------------------------------- /samples/hosts/commissionHostsSpec.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "fqdn": "sfo01-w01-esx01.sfo.rainpole.io", 4 | "username": "root", 5 | "storageType": "VSAN", 6 | "password": "VMw@re1!", 7 | "networkPoolName": "sfo-w01-np01", 8 | "networkPoolId": "850c1edc-71f8-47e2-8308-66000338f67a" 9 | }, 10 | { 11 | "fqdn": "sfo01-w01-esx02.sfo.rainpole.io", 12 | "username": "root", 13 | "storageType": "VSAN", 14 | "password": "VMw@re1!", 15 | "networkPool Name": "sfo-w01-np01", 16 | "networkPoolId": "850c1edc-71f8-47e2-8308-66000338f67a" 17 | }, 18 | { 19 | "fqdn": "sfo01-w01-esx03.sfo.rainpole.io", 20 | "username": "root", 21 | "storageType": "VSAN", 22 | "password": "VMw@re1!", 23 | "networkPoolName": "sfo-w01-np01", 24 | "networkPoolId": "850c1edc-71f8-47e2-8308-66000338f67a" 25 | }, 26 | { 27 | "fqdn": "sfo01-w01-esx04.sfo.rainpole.io", 28 | "username": "root", 29 | "storageType": "VSAN", 30 | "password": "VMw@re1!", 31 | "networkPoolName": "sfo-w01-np01", 32 | "networkPoolId": "850c1edc-71f8-47e2-8308-66000338f67a" 33 | } 34 | ] 35 | -------------------------------------------------------------------------------- /samples/hosts/decommissionHostsSpec.json: -------------------------------------------------------------------------------- 1 | [ { 2 | "fqdn": "sfo01-w01-esx01.sfo.rainpole.io" 3 | },{ 4 | "fqdn": "sfo01-w01-esx02.sfo.rainpole.io" 5 | },{ 6 | "fqdn": "sfo01-w01-esx03.sfo.rainpole.io" 7 | },{ 8 | "fqdn": "sfo01-w01-esx04.sfo.rainpole.io" 9 | }] 10 | -------------------------------------------------------------------------------- /samples/hosts/ui-commissionHostsSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "hostsSpec": [ 3 | { 4 | "hostfqdn": "sfo01-w01-esx01.sfo.rainpole.io", 5 | "username": "root", 6 | "storageType": "VSAN", 7 | "password": "VMw@re1!", 8 | "networkPoolName": "sfo-w01-np01" 9 | }, 10 | { 11 | "hostfqdn": "sfo01-w01-esx02.sfo.rainpole.io", 12 | "username": "root", 13 | "storageType": "VSAN", 14 | "password": "VMw@re1!", 15 | "networkPoolName": "sfo-w01-np01" 16 | }, 17 | { 18 | "hostfqdn": "sfo01-w01-esx03.sfo.rainpole.io", 19 | "username": "root", 20 | "storageType": "VSAN", 21 | "password": "VMw@re1!", 22 | "networkPoolName": "sfo-w01-np01" 23 | }, 24 | { 25 | "hostfqdn": "sfo01-w01-esx04.sfo.rainpole.io", 26 | "username": "root", 27 | "storageType": "VSAN", 28 | "password": "VMw@re1!", 29 | "networkPoolName": "sfo-w01-np01" 30 | } 31 | ] 32 | } -------------------------------------------------------------------------------- /samples/idp/embeddedIdpSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "SFO01", 3 | "ldap": { 4 | "domainName": "sfo.rainpole.io", 5 | "password": "VMw@re123!", 6 | "type": "ActiveDirectory", 7 | "username": "svc-vsphere-ad@sfo.rainpole.io", 8 | "sourceDetails": { 9 | "certChain": [ 10 | "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURkVENDQWwyZ0F3SUJBZ0lRUTloMjhIamk2SXBLMjZwVW9nenVxVEFOQmdrcWhraUc5dzBCQVFzRkFEQk4KTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXNaQUVaRmdoeVlXbHVjRzlzWlRFZApNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3SGhjTk1qTXdOVEU0TURjeE56RXlXaGNOCk1qZ3dOVEU0TURjeU56RXhXakJOTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXMKWkFFWkZnaHlZV2x1Y0c5c1pURWRNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3Z2dFaQpNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUJEd0F3Z2dFS0FvSUJBUUNaTjlBaDY1aVpobGJPbUVRTDJXSjNCZk1BClB6WVhLWnc4Rkh4bkl3eE8vRU93QkxnM0R3YVpMck8yR1UrdVlGTDI0VUh2WVBvVVNpcTRyeHZIN0RzQWFpWFIKRjloeUEyemJyMFJVY25nWXdPdXJTMlhoazBBbG9YSzBqNVJkcE1vUzRYZFAyaXY1Rkk0NHBpeWJBY2hwM0dMVQorNCtqUFJWc2Nma3J1OVhDeTMwemdkdkQrTFAvZzE1ZTdZUjFGYkszcGNGUmFIU2FsL2FRdXRuTlZTbDk5b0xyCnpDRlNFcnArYVVXdVh5d2N4dXU3WjE1TU5Qd3BVdzIwQXdNUmM3cmoyVnJaZmZwTitLUVRFMm9CUmZHWU9rYS8KcHVQMW5iUm1MS0pjME0zWjJrNDQzM1JDSEVQL3F0WVJhMG45aHN1cFBvQUJOM1EwcTQxanVtcll2SWhGQWdNQgpBQUdqVVRCUE1Bc0dBMVVkRHdRRUF3SUJoakFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQjBHQTFVZERnUVdCQlNMCk9rTWVaWnNoQ0RMR1lxejBOVXBmb1lEWVJUQVFCZ2tyQmdFRUFZSTNGUUVFQXdJQkFEQU5CZ2txaGtpRzl3MEIKQVFzRkFBT0NBUUVBaTlPdjhpT1lUcUxicnIrLzhLbXBYRzkxY0thQWRtTHBIck5QaktvWUF4UUFGOEtPQlBEeQprZlNBa3NxWWRaV01JQzVjbUFyby9vMnJhbGh1K2NkN04wWThlbUUyUkJkUml3UnZVTjFpVlFkQkNuMXRPQ3FTCjVHWFNHMzRNR1J4OVUraUlYSHQyUUhmekUwMVdHeVdnYW8wRjV0RFliV3NCMDA5bkhmQjc3YjNxR1cwbHlOVG4KQXllT1RrRm12cSsyT3VOR2poQm5ydjJBaXpucTRJQStteG12WnU0Y29ZY0ZOQTBLSlBKVVdZcWZMVnE2SzdydQowaVJVUUpuQTN6cFVKemNxRXBscDlsQ3J0aFF6MVVtMzdVZkRpMzJ1K0lQeUt2c2lMQ3FCYzE3ME80ZXZ3QWhUCmovaFYxbzkzQUVUS2hnUWI1NlpXRFNsTXUxMWVMazhPbXc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" 11 | ], 12 | "serverEndpoints": [ 13 | "ldaps://sfo-dc01.sfo.rainpole.io:636" 14 | ], 15 | "groupsBaseDn": "OU=Security Groups,DC=sfo,DC=rainpole,DC=io", 16 | "usersBaseDn": "OU=Security Users,DC=sfo,DC=rainpole,DC=io" 17 | } 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /samples/idp/externalIdpSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ADFS01", 3 | "type": "AD_FS", 4 | "certChain": [ 5 | "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURkVENDQWwyZ0F3SUJBZ0lRUTloMjhIamk2SXBLMjZwVW9nenVxVEFOQmdrcWhraUc5dzBCQVFzRkFEQk4KTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXNaQUVaRmdoeVlXbHVjRzlzWlRFZApNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3SGhjTk1qTXdOVEU0TURjeE56RXlXaGNOCk1qZ3dOVEU0TURjeU56RXhXakJOTVJJd0VBWUtDWkltaVpQeUxHUUJHUllDYVc4eEdEQVdCZ29Ka2lhSmsvSXMKWkFFWkZnaHlZV2x1Y0c5c1pURWRNQnNHQTFVRUF4TVVjbUZwYm5CdmJHVXRVbEJNTFVSRE1ERXRRMEV3Z2dFaQpNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUJEd0F3Z2dFS0FvSUJBUUNaTjlBaDY1aVpobGJPbUVRTDJXSjNCZk1BClB6WVhLWnc4Rkh4bkl3eE8vRU93QkxnM0R3YVpMck8yR1UrdVlGTDI0VUh2WVBvVVNpcTRyeHZIN0RzQWFpWFIKRjloeUEyemJyMFJVY25nWXdPdXJTMlhoazBBbG9YSzBqNVJkcE1vUzRYZFAyaXY1Rkk0NHBpeWJBY2hwM0dMVQorNCtqUFJWc2Nma3J1OVhDeTMwemdkdkQrTFAvZzE1ZTdZUjFGYkszcGNGUmFIU2FsL2FRdXRuTlZTbDk5b0xyCnpDRlNFcnArYVVXdVh5d2N4dXU3WjE1TU5Qd3BVdzIwQXdNUmM3cmoyVnJaZmZwTitLUVRFMm9CUmZHWU9rYS8KcHVQMW5iUm1MS0pjME0zWjJrNDQzM1JDSEVQL3F0WVJhMG45aHN1cFBvQUJOM1EwcTQxanVtcll2SWhGQWdNQgpBQUdqVVRCUE1Bc0dBMVVkRHdRRUF3SUJoakFQQmdOVkhSTUJBZjhFQlRBREFRSC9NQjBHQTFVZERnUVdCQlNMCk9rTWVaWnNoQ0RMR1lxejBOVXBmb1lEWVJUQVFCZ2tyQmdFRUFZSTNGUUVFQXdJQkFEQU5CZ2txaGtpRzl3MEIKQVFzRkFBT0NBUUVBaTlPdjhpT1lUcUxicnIrLzhLbXBYRzkxY0thQWRtTHBIck5QaktvWUF4UUFGOEtPQlBEeQprZlNBa3NxWWRaV01JQzVjbUFyby9vMnJhbGh1K2NkN04wWThlbUUyUkJkUml3UnZVTjFpVlFkQkNuMXRPQ3FTCjVHWFNHMzRNR1J4OVUraUlYSHQyUUhmekUwMVdHeVdnYW8wRjV0RFliV3NCMDA5bkhmQjc3YjNxR1cwbHlOVG4KQXllT1RrRm12cSsyT3VOR2poQm5ydjJBaXpucTRJQStteG12WnU0Y29ZY0ZOQTBLSlBKVVdZcWZMVnE2SzdydQowaVJVUUpuQTN6cFVKemNxRXBscDlsQ3J0aFF6MVVtMzdVZkRpMzJ1K0lQeUt2c2lMQ3FCYzE3ME80ZXZ3QWhUCmovaFYxbzkzQUVUS2hnUWI1NlpXRFNsTXUxMWVMazhPbXc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" 6 | ], 7 | "ldap": { 8 | "username": "svc-vcf-ca@rainpole.io", 9 | "password": "VMw@re123!", 10 | "sourceDetails": { 11 | "certChain": [], 12 | "serverEndpoints": [ 13 | "ldap://rpl-dc01.rainpole.io:389" 14 | ], 15 | "groupsBaseDn": "OU=Security Groups,DC=rainpole,DC=io", 16 | "usersBaseDn": "OU=Security Users,DC=rainpole,DC=io" 17 | } 18 | }, 19 | "oidc": { 20 | "clientId": "d49b72f6-ec04-41bb-bad6-aad368af2fe5", 21 | "clientSecret": "HFEH59piO3NfzbFp9O5rGskCVEdBQ_aM8dTPo8wer", 22 | "discoveryEndpoint": "https://rpl-dc01.rainpole.io/adfs/.well-known/openid-configuration" 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /samples/network-pools/networkPoolSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sfo-w01-np01", 3 | "networks": [ 4 | { 5 | "type": "VMOTION", 6 | "vlanId": 2612, 7 | "mtu": 9000, 8 | "subnet": "172.18.104.0", 9 | "mask": "255.255.255.0", 10 | "gateway": "172.18.104.1", 11 | "ipPools": [ 12 | { 13 | "start": "172.18.104.101", 14 | "end": "172.18.104.104" 15 | } 16 | ] 17 | }, 18 | { 19 | "type": "VSAN", 20 | "vlanId": 2613, 21 | "mtu": 9000, 22 | "subnet": "172.18.105.0", 23 | "mask": "255.255.255.0", 24 | "gateway": "172.18.105.1", 25 | "ipPools": [ 26 | { 27 | "start": "172.18.105.101", 28 | "end": "172.18.105.104" 29 | } 30 | ] 31 | } 32 | ] 33 | } 34 | -------------------------------------------------------------------------------- /samples/proxy/proxySpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "isEnabled": true, 3 | "host": "proxy.rainpole.io", 4 | "port": 3128 5 | } 6 | -------------------------------------------------------------------------------- /samples/sos/healthSummarySpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "healthChecks": { 3 | "certificateHealth": true, 4 | "composabilityHealth": true, 5 | "computeHealth": true, 6 | "connectivityHealth": true, 7 | "dnsHealth": true, 8 | "generalHealth": true, 9 | "hardwareCompatibilityHealth": true, 10 | "ntpHealth": true, 11 | "passwordHealth": true, 12 | "servicesHealth": true, 13 | "storageHealth": true 14 | }, 15 | "options": { 16 | "config": { 17 | "force": false, 18 | "skipKnownHostCheck": false 19 | }, 20 | "include": { 21 | "summaryReport": true 22 | } 23 | }, 24 | "scope": { 25 | "domains": [ 26 | { 27 | "clusterNames": [""], 28 | "domainName": "" 29 | } 30 | ], 31 | "includeAllDomains": true, 32 | "includeFreeHosts": true 33 | } 34 | } -------------------------------------------------------------------------------- /samples/sos/supportBundleSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "logs": { 3 | "apiLogs": false, 4 | "esxLogs": false, 5 | "nsxLogs": false, 6 | "sddcManagerLogs": true, 7 | "systemDebugLogs": false, 8 | "vcLogs": false, 9 | "vmScreenshots": false, 10 | "vraLogs": false, 11 | "vrliLogs": false, 12 | "vropsLogs": false, 13 | "vrslcmLogs": false, 14 | "vxrailManagerLogs": false, 15 | "wcpLogs": false 16 | }, 17 | "options": { 18 | "config": { 19 | "force": false, 20 | "skipKnownHostCheck": false 21 | }, 22 | "include": { 23 | "healthCheck": false, 24 | "summaryReport": false 25 | } 26 | }, 27 | "scope": { 28 | "domains": [ { 29 | "clusterNames": [ "" ], 30 | "domainName": "" 31 | } ], 32 | "includeFreeHosts": false 33 | } 34 | } -------------------------------------------------------------------------------- /samples/system-prechecks/precheckSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources" : [ { 3 | "resourceId" : "f5af221e-6a27-4370-b7d6-4c95279e1d22", 4 | "type" : "DOMAIN" 5 | } ] 6 | } -------------------------------------------------------------------------------- /samples/upgrades/upgradeDomainSpec.json: -------------------------------------------------------------------------------- 1 | { 2 | "bundleId": "6b5d5a0e-5bdc-4679-82c3-860bd660ea83", 3 | "parallelUpgrade": true, 4 | "resourceType": "DOMAIN", 5 | "resourceUpgradeSpecs": [ { 6 | "resourceId": "565d2fc3-00a3-4f25-b868-2d25db933614", 7 | "shutdownVms": false, 8 | "upgradeNow": true 9 | } ] 10 | } --------------------------------------------------------------------------------