diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index a15344bb3..958cc1908 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -32,7 +32,10 @@ body: id: version-vcf attributes: label: VMware Cloud Foundation - description: Please provide the VMware Cloud Foundation version. + description: > + Please provide the VMware Cloud Foundation version. + + For details on specific VMware Cloud Foundation versions supported by this module, please refer to the [documentation](https://vmware.github.io/powershell-module-for-vmware-cloud-foundation/). validations: required: true - type: input diff --git a/.github/labeler-pull-requests.yml b/.github/labeler-pull-requests.yml new file mode 100644 index 000000000..c0de566e2 --- /dev/null +++ b/.github/labeler-pull-requests.yml @@ -0,0 +1,22 @@ +--- +chore: + - changed-files: + - any-glob-to-any-file: + - ".ci/**/*" + - ".github/**/*" + - ".gitignore" +documentation: + - changed-files: + - any-glob-to-any-file: + - "**/*.md" + - "Makefile" + - "**/*.md" + - "mkdocs.yml" +github-actions: + - changed-files: + - any-glob-to-any-file: + - ".github/workflows/**/*" +needs-review: + - changed-files: + - any-glob-to-any-file: + - "**" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 53efe0078..807c1e703 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -12,7 +12,7 @@ jobs: with: fetch-depth: 0 - name: Setup Python - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: 3.x - name: Install Dependencies diff --git a/.github/workflows/pull-request-sizing.yml b/.github/workflows/pull-request-sizing.yml deleted file mode 100644 index a83cefc54..000000000 --- a/.github/workflows/pull-request-sizing.yml +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Pull Request Labels -'on': - - pull_request_target -jobs: - triage: - runs-on: ubuntu-latest - steps: - - uses: codelytv/pr-size-labeler@54ef36785e9f4cb5ecf1949cfc9b00dbb621d761 # v1.8.1 - with: - GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' - xs_label: size/xs - xs_max_size: '10' - s_label: size/s - s_max_size: '100' - m_label: size/m - m_max_size: '500' - l_label: size/l - l_max_size: '1000' - xl_label: size/xl - fail_if_xl: 'false' - message_if_xl: > - 'This pull request exceeds the recommended size of 1000 lines - and might be rejected due to its size. - - - Please make sure you are not addressing multiple issues in a - pull request.’ - github_api_url: api.github.com diff --git a/.github/workflows/pull-requests.yml b/.github/workflows/pull-requests.yml new file mode 100644 index 000000000..73c044ed9 --- /dev/null +++ b/.github/workflows/pull-requests.yml @@ -0,0 +1,27 @@ +--- +name: Pull Request Labels + +on: + pull_request_target: + branches: + - develop + types: + - opened + - synchronize + - reopened + - edited + - ready_for_review + +jobs: + labeler: + name: Labeler + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - name: Apply Labels + uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0 + with: + configuration-path: .github/labeler-pull-requests.yml + repo-token: '${{ secrets.GITHUB_TOKEN }}' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 781263a89..4d7e4432c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -136,7 +136,7 @@ jobs: ref: ${{ github.event.release.tag_name }} fetch-depth: 0 - name: Setup Python - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: 3.x - name: Install Dependencies diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 3ac14e87a..7b2fb857a 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -10,7 +10,7 @@ jobs: issues: write pull-requests: write steps: - - uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0 + - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0 with: repo-token: '${{ secrets.GITHUB_TOKEN }}' days-before-stale: 60 diff --git a/CHANGELOG.md b/CHANGELOG.md index 74956fc70..76e12c99b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,33 @@ # Release History +## v2.5.0 + +> Released: Unreleased + +- Added cmdlets for auditing PCI Compliance in VMware Cloud Foundation 5.2 and later. + - Added `Get-VCFCompliance` to retrieve a specific compliance audit result. + - Added `Get-VCFComplianceConfiguration` to retrieve a list of all compliance configurations along with their applicable resource types and versions. + - Added `Get-VCFComplianceHistory` to retrieve the history for all compliance audits that have been performed. + - Added `Get-VCFComplianceStandard` to retrieve a list of all compliance audit standards and versions that are supported. + - Added `Get-VCFCompliance` to retrieve a specific compliance audit result. + - Added `New-VCFCompliance` to run a new compliance audit. +- Added `Export-VCFManagementDomainJsonSpec` to export the JSON specification required for bring-up from the Planning and Preparation workbook. +- Enhanced the request headers to include `Content-Type` to ensure REST API calls do not error out. +- Enhanced `ResponseException` function to accept optional `-Body` parameter to include the JSON payload for ease of debugging. +- Enhanced `New-VCFWorkloadDomain` cmdlet to improve error handling. +- Enhanced `New-VCFCommissionedHost` cmdlet to improve error handling. +- Enhanced `New-VCFCommissionedHost` cmdlet with ability to use the host commission JSON specification provided by the SDDC Manager UI. +- Updated `Get-VCFTask` cmdlet with additional exception message to catch. +- Updated `Get-VCFSystemPrecheckTask` cmdlet with optional parameter `failureOnly`. +- Updated `Get-VCFPersonality` cmdlet with optional parameter `name`. +- Updated `New-VCFWorkloadDomain` cmdlet with optional parameter `validate` to validate the JSON specification. +- Refactored `Invoke-VCFCommand` to run commands on SDDC Manager without the need for SSH across PowerShell editions and operating systems. +- Removed deprecated `Commission-VCFHost` alias from `New-VCFCommissionedHost`. +- Removed deprecated `Decommission-VCFHost` alias from `Remove-VCFCommissionedHost`. +- Removed deprecated `Get-VCFNsxManagerCluster` alias from `Get-VCFNsxtCluster`. +- Removed deprecated `Get-VCFNsxEdgeCluster` alias from `Get-VCFEdgeCluster`. +- Removed deprecated `New-VCFNsxEdgeCluster` alias from `New-VCFEdgeCluster`. + ## v2.4.1 > Released: 2023-12-15 diff --git a/LICENSE b/LICENSE index 78243bc20..6911668eb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 2-Clause License -Copyright 2023 Broadcom. All Rights Reserved. +Copyright 2023-2024 Broadcom. All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/Makefile b/Makefile index 6413dff98..d752dd74f 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -# Copyright 2023 Broadcom. All Rights Reserved. +# Copyright 2023-2024 Broadcom. All Rights Reserved. # SPDX-License-Identifier: BSD-2 docs-install: diff --git a/NOTICE b/NOTICE index ec7d31557..7dc0cc0e8 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,5 @@ PowerShell Module for VMware Cloud Foundation -Copyright 2023 Broadcom. All Rights Reserved. +Copyright 2023-2024 Broadcom. All Rights Reserved. This product is licensed to you under the BSD-2 license (the "License"). You may not use this product except in compliance with the BSD-2 License. diff --git a/PowerVCF.psd1 b/PowerVCF.psd1 index 695e5efeb..4101c4bb8 100644 --- a/PowerVCF.psd1 +++ b/PowerVCF.psd1 @@ -1,100 +1,100 @@ -# Copyright 2023 Broadcom. All Rights Reserved. +# Copyright 2023-2024 Broadcom. All Rights Reserved. # SPDX-License-Identifier: BSD-2 # Module manifest for module 'PowerVCF' # Generated by: Broadcom -# Generated on: 2023-12-15 +# Generated on: 2024-07-02 @{ -# Script module or binary module file associated with this manifest. -RootModule = 'PowerVCF.psm1' + # Script module or binary module file associated with this manifest. + RootModule = 'PowerVCF.psm1' -# Version number of this module. -ModuleVersion = '2.4.1.1000' + # Version number of this module. + ModuleVersion = '2.5.0.1016' -# Supported PSEditions -# CompatiblePSEditions = @() + # Supported PSEditions + # CompatiblePSEditions = @() -# ID used to uniquely identify this module -GUID = '0558cc7e-71a6-4b08-b9be-341d22653128' + # ID used to uniquely identify this module + GUID = '0558cc7e-71a6-4b08-b9be-341d22653128' -# Author of this module -Author = 'Broadcom' + # Author of this module + Author = 'Broadcom' -# Company or vendor of this module -CompanyName = 'Broadcom' + # Company or vendor of this module + CompanyName = 'Broadcom' -# Copyright statement for this module -Copyright = 'Copyright 2023 Broadcom. All Rights Reserved.' + # Copyright statement for this module + Copyright = 'Copyright 2023-2024 Broadcom. All Rights Reserved.' -# Description of the functionality provided by this module -Description = 'PowerShell Module for VMware Cloud Foundation' + # Description of the functionality provided by this module + Description = 'PowerShell Module for VMware Cloud Foundation' -# Minimum version of the Windows PowerShell engine required by this module -# PowerShellVersion = '5.0' + # Minimum version of the Windows PowerShell engine required by this module + # PowerShellVersion = '5.0' -# Name of the Windows PowerShell host required by this module -# PowerShellHostName = '' + # Name of the Windows PowerShell host required by this module + # PowerShellHostName = '' -# Minimum version of the Windows PowerShell host required by this module -# PowerShellHostVersion = '' + # Minimum version of the Windows PowerShell host required by this module + # PowerShellHostVersion = '' -# Modules that must be imported into the global environment prior to importing this module -# RequiredModules = @('') + # Modules that must be imported into the global environment prior to importing this module + # RequiredModules = @('') -# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess -# NestedModules = @() + # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess + # NestedModules = @() -# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = '*' + # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. + FunctionsToExport = '*' -# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. -CmdletsToExport = '*' + # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. + CmdletsToExport = '*' -# Variables to export from this module -VariablesToExport = '*' + # Variables to export from this module + VariablesToExport = '*' -# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. -# AliasesToExport = @() + # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. + # AliasesToExport = @() -# DSC resources to export from this module -# DscResourcesToExport = @() + # DSC resources to export from this module + # DscResourcesToExport = @() -# List of all modules packaged with this module -# ModuleList = @() + # List of all modules packaged with this module + # ModuleList = @() -# List of all files packaged with this module -# FileList = @() + # List of all files packaged with this module + # FileList = @() -# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. -PrivateData = @{ + # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. + PrivateData = @{ - PSData = @{ + PSData = @{ - # Tags applied to this module. These help with module discovery in online galleries. - Tags = @('VMware', 'CloudFoundation', 'VMwareCloudFoundation') + # Tags applied to this module. These help with module discovery in online galleries. + Tags = @('VMware', 'CloudFoundation', 'VMwareCloudFoundation') - # A URL to the license for this module. - LicenseUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/blob/main/LICENSE' + # A URL to the license for this module. + LicenseUri = 'https://github.com/vmware/powershell-module-for-vmware-cloud-foundation/blob/main/LICENSE' - # A URL to the main website for this project. - ProjectUri = 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation' + # A URL to the main website for this project. + ProjectUri = 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation' - # A URL to an icon representing this module. - IconUri = 'https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation/main/.github/icon-85px.svg' + # A URL to an icon representing this module. + IconUri = 'https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation/main/.github/icon-85px.svg' - # ReleaseNotes of this module - ReleaseNotes = 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation/release-notes/' + # ReleaseNotes of this module + ReleaseNotes = 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation/release-notes/' - } # End of PSData hashtable + } # End of PSData hashtable -} # End of PrivateData hashtable + } # End of PrivateData hashtable -# HelpInfo URI of this module -# HelpInfoURI = '' + # HelpInfo URI of this module + # HelpInfoURI = '' -# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. -# DefaultCommandPrefix = '' + # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. + # DefaultCommandPrefix = '' } diff --git a/PowerVCF.psm1 b/PowerVCF.psm1 index c06fd4d7a..b1fd807cf 100644 --- a/PowerVCF.psm1 +++ b/PowerVCF.psm1 @@ -1,4 +1,4 @@ -# Copyright 2023 Broadcom. All Rights Reserved. +# Copyright 2023-2024 Broadcom. All Rights Reserved. # SPDX-License-Identifier: BSD-2 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE @@ -19,7 +19,7 @@ if ($PSEdition -eq 'Desktop') { [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12; If (!("TrustAllCertificatePolicy" -as [type])) { - add-type @" + add-type @" using System.Net; using System.Security.Cryptography.X509Certificates; public class TrustAllCertificatePolicy : ICertificatePolicy { @@ -31,13 +31,13 @@ if ($PSEdition -eq 'Desktop') { } } "@ -} + } [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertificatePolicy } #Region Global Variables -Set-Variable -Name msgVcfApiNotAvailable -Value "This API is not available in the latest versions of VMware Cloud Foundation.:" -Scope Global +Set-Variable -Name msgVcfApiNotAvailable -Value "This API is not available in the latest versions of VMware Cloud Foundation:" -Scope Global Set-Variable -Name msgVcfApiNotSupported -Value "This API is not supported on this version of VMware Cloud Foundation:" -Scope Global Set-Variable -Name msgVcfApiDeprecated -Value "This API is deprecated on this version of VMware Cloud Foundation:" -Scope Global @@ -55,11 +55,25 @@ Function Request-VCFToken { .EXAMPLE Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username administrator@vsphere.local -password VMw@re1! - This example shows how to connect to SDDC Manager to request API access and refresh tokens. + This example shows how to connect to SDDC Manager using a clear-text username and password. + + .EXAMPLE + $secureString = Read-Host -AsSecureString 'Password' + Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username admin@local -password $secureString + This example shows how to connect to the SDDC Manager instance using a SecureString password. + + .EXAMPLE + $credential = Get-Credential + Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -credential $credential + This example shows how to connect to the SDDC Manager instance using a PSCredential object. + + .EXAMPLE + Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username admin@local + This example shows how to connect to the SDDC Manager instance where the user will be prompted for a password. .EXAMPLE - Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username admin@local -password VMw@re1!VMw@re1! - This example shows how to connect to SDDC Manager using local account admin@local. + Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io + This example shows how to connect to the SDDC Manager instance where the user will be prompted for a username and password. .PARAMETER fqdn The fully qualified domain name of the SDDC Manager instance. @@ -69,22 +83,49 @@ Function Request-VCFToken { .PARAMETER password The password to authenticate to the SDDC Manager instance. + This parameter takes either a string or a SecureString value. + If not specified, the user will be prompted for the SecureString value. + + .PARAMETER credential + Specifies to authenticate to the SDDC Manager instance using a PSCredential object. .PARAMETER skipCertificateCheck Switch to skip certificate check when connecting to the SDDC Manager instance. #> + [CmdletBinding(DefaultParameterSetName = 'PSCredentialSet')] + Param ( - [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$fqdn, - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$username, - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$password, + [Parameter (Mandatory = $true, ParameterSetName = 'UserNameAndPasswordSet')] + [Parameter (Mandatory = $true, ParameterSetName = 'PSCredentialSet')] [ValidateNotNullOrEmpty()] [string]$fqdn, + [Parameter (Mandatory = $true, ParameterSetName = 'UserNameAndPasswordSet')] [ValidateNotNullOrEmpty()] [string]$username, + [Parameter (Mandatory = $false, ParameterSetName = 'UserNameAndPasswordSet')][ValidateNotNullOrEmpty()] [Object]$password, + [Parameter (Mandatory = $true, ParameterSetName = 'PSCredentialSet')] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()]$credential, [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$skipCertificateCheck ) - if ( -not $PsBoundParameters.ContainsKey("username") -or ( -not $PsBoundParameters.ContainsKey("password"))) { - $creds = Get-Credential # Request Credentials - $username = $creds.UserName.ToString() - $password = $creds.GetNetworkCredential().password + try { + if ($PSCmdlet.ParameterSetName -eq 'UserNameAndPasswordSet') { + $user = $UserName + + if (-not($PSBoundParameters.ContainsKey('password'))) { + $password = Read-Host -AsSecureString 'Password' + $decryptedPassword = [Runtime.InteropServices.Marshal]::PtrToStringBSTR([Runtime.InteropServices.Marshal]::SecureStringToBSTR($password)) + } elseif ($password -isnot [SecureString]) { + if ($password -isnot [System.String]) { + throw 'Password should either be a String or SecureString (recommended).' + } else { + $decryptedPassword = $password + } + } else { + $decryptedPassword = [Runtime.InteropServices.Marshal]::PtrToStringBSTR([Runtime.InteropServices.Marshal]::SecureStringToBSTR($password)) + } + } elseif ($PSCmdlet.ParameterSetName -eq 'PSCredentialSet') { + $user = $Credential.UserName + $decryptedPassword = $Credential.GetNetworkCredential().Password + } + } catch { + $PSCmdlet.ThrowTerminatingError($_) } if ($PsBoundParameters.ContainsKey("skipCertificateCheck")) { @@ -106,19 +147,19 @@ public static class Placeholder { } } "@ -} + } [System.Net.ServicePointManager]::ServerCertificateValidationCallback = [placeholder]::GetDelegate() } $Global:sddcManager = $fqdn $headers = @{"Content-Type" = "application/json" } - $uri = "https://$sddcManager/v1/tokens" # Set URI for executing an API call to validate authentication - $body = '{"username": "' + $username + '","password": "' + $password + '"}' + $uri = "https://$sddcManager/v1/tokens" + $body = '{"username": "' + $user + '","password": "' + $decryptedPassword + '"}' Try { # Checking authentication with SDDC Manager if ($PSEdition -eq 'Core') { - $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -Body $body -SkipCertificateCheck # PS Core has -SkipCertificateCheck implemented + $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -Body $body -SkipCertificateCheck $Global:accessToken = $response.accessToken $Global:refreshToken = $response.refreshToken.id } else { @@ -145,8 +186,26 @@ Function Connect-CloudBuilder { credentials in a base64 string. .EXAMPLE - Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin -password VMware1! - This example shows how to connect to the VMware Cloud Builder instance. + Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin -password VMw@re1! + This example shows how to connect to the VMware Cloud Builder instance using a clear-text username and password. + + .EXAMPLE + $secureString = Read-Host -AsSecureString 'Password' + Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin -password $secureString + This example shows how to connect to the specified VMware Cloud Builder instance using a SecureString password. + + .EXAMPLE + $credential = Get-Credential + Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -credential $credential + This example shows how to connect to the specified VMware Cloud Builder instance using a PSCredential object. + + .EXAMPLE + Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin + This example shows how to connect to the specified VMware Cloud Builder instance where the user will be prompted for a password. + + .EXAMPLE + Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io + This example shows how to connect to the specified VMware Cloud Builder instance where the user will be prompted for a username and password. .PARAMETER fqdn The fully qualified domain name of the VMware Cloud Builder instance. @@ -156,22 +215,50 @@ Function Connect-CloudBuilder { .PARAMETER password The password to authenticate to the VMware Cloud Builder instance. + This parameter takes either a string or a SecureString value. + If not specified, the user will be prompted for the SecureString value. + + .PARAMETER credential + Specifies a user account to authenticate to the SDDC Manager instance using a PSCredential object. .PARAMETER skipCertificateCheck Switch to skip certificate check when connecting to the VMware Cloud Builder instance. #> + [CmdletBinding(DefaultParameterSetName = 'PSCredentialSet')] + Param ( - [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$fqdn, - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$username, - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$password, + [Parameter (Mandatory = $true, ParameterSetName = 'UserNameAndPasswordSet')] + [Parameter (Mandatory = $true, ParameterSetName = 'PSCredentialSet')] [ValidateNotNullOrEmpty()] [string]$fqdn, + [Parameter (Mandatory = $true, ParameterSetName = 'UserNameAndPasswordSet')] [ValidateNotNullOrEmpty()] [string]$username, + [Parameter (Mandatory = $false, ParameterSetName = 'UserNameAndPasswordSet')] [ValidateNotNullOrEmpty()] [Object]$password, + [Parameter (Mandatory = $true, ParameterSetName = 'PSCredentialSet')] + [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()]$credential, [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$skipCertificateCheck ) - if ( -not $PsBoundParameters.ContainsKey("username") -or ( -not $PsBoundParameters.ContainsKey("password"))) { - $creds = Get-Credential # Request Credentials - $username = $creds.UserName.ToString() - $password = $creds.GetNetworkCredential().password + try { + if ($PSCmdlet.ParameterSetName -eq 'UserNameAndPasswordSet') { + $user = $username + + if (-not($PSBoundParameters.ContainsKey('password'))) { + $Password = Read-Host -AsSecureString 'Password' + $decryptedPassword = [Runtime.InteropServices.Marshal]::PtrToStringBSTR([Runtime.InteropServices.Marshal]::SecureStringToBSTR($password)) + } elseif ($password -isnot [SecureString]) { + if ($password -isnot [System.String]) { + throw 'Password should either be a String or SecureString (recommended).' + } else { + $decryptedPassword = $password + } + } else { + $decryptedPassword = [Runtime.InteropServices.Marshal]::PtrToStringBSTR([Runtime.InteropServices.Marshal]::SecureStringToBSTR($password)) + } + } elseif ($PSCmdlet.ParameterSetName -eq 'PSCredentialSet') { + $user = $Credential.UserName + $decryptedPassword = $Credential.GetNetworkCredential().Password + } + } catch { + $PSCmdlet.ThrowTerminatingError($_) } if ($PsBoundParameters.ContainsKey("skipCertificateCheck")) { @@ -193,26 +280,26 @@ public static class Placeholder { } } "@ -} + } [System.Net.ServicePointManager]::ServerCertificateValidationCallback = [placeholder]::GetDelegate() } $Global:cloudBuilder = $fqdn - $Global:base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $username, $password))) # Create Basic Authentication Encoded Credentials + $Global:base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user, $decryptedPassword))) # Create Basic Authentication Encoded Credentials $headers = @{"Accept" = "application/json" } $headers.Add("Authorization", "Basic $base64AuthInfo") - $uri = "https://$cloudBuilder/v1/sddcs" # Set URI for executing an API call to validate authentication + $uri = "https://$cloudBuilder/v1/sddcs" Try { - # Checking authentication with VMware Cloud Builder + # Checking authentication with VMware Cloud Builder. if ($PSEdition -eq 'Core') { - $response = Invoke-WebRequest -Method GET -Uri $uri -Headers $headers -SkipCertificateCheck # PS Core has -SkipCertificateCheck implemented + $response = Invoke-WebRequest -Method GET -Uri $uri -Headers $headers -SkipCertificateCheck } else { $response = Invoke-WebRequest -Method GET -Uri $uri -Headers $headers } if ($response.StatusCode -eq 200) { - Write-Output "Successfully connected to the Cloud Builder Appliance: $cloudBuilder" + Write-Output "Successfully connected to the Cloud Builder appliance: $cloudBuilder" } } Catch { ResponseException -object $_ @@ -1048,7 +1135,7 @@ Function Set-VCFCertificate { ) if ($PsBoundParameters.ContainsKey("json")) { - Try { + Try { $jsonBody = validateJsonInput -json $json createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. @@ -1173,13 +1260,11 @@ Function New-VCFCluster { $uri = "https://$sddcManager/v1/clusters" $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody $response - } - Catch { + } Catch { ResponseException -object $_ } - } - else { - Write-Error "The validation task commpleted the run with the following problems: $($response.validationChecks.errorResponse.message)" + } else { + Write-Error "The validation task completed the run with the following problems: $($response.validationChecks.errorResponse.message)" } } Catch { ResponseException -object $_ @@ -1231,9 +1316,10 @@ Function Set-VCFCluster { Throw "You must include either -json or -markForDeletion" } - $jsonBody = validateJsonInput -json $json # validate input file and format - $response = Validate-VCFUpdateClusterSpec -clusterid $id -json $jsonBody # validate the JSON provided meets the cluster specifications format - # the validation API does not currently support polling with a task ID + if ($PsBoundParameters.ContainsKey("json")) { + $jsonBody = validateJsonInput -json $json # Validate input file and format. + $response = Validate-VCFUpdateClusterSpec -clusterid $id -json $jsonBody # Validate the JSON provided meets the cluster specifications format. + # The validation API does not currently support polling with a task ID. Start-Sleep -Seconds 5 # Submit the job only if the JSON validation task finished with executionStatus of COMPLETED and resultStatus of SUCCEEDED. if ($response.executionStatus -eq "COMPLETED" -and $response.resultStatus -eq "SUCCEEDED") { @@ -1242,14 +1328,13 @@ Function Set-VCFCluster { $uri = "https://$sddcManager/v1/clusters/$id/" $response = Invoke-RestMethod -Method PATCH -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody $response - } - Catch { + } Catch { ResponseException -object $_ } + } else { + Write-Error "The validation task completed the run with the following problems: $($response.validationChecks.errorResponse.message)" } - else { - Write-Error "The validation task commpleted the run with the following problems: $($response.validationChecks.errorResponse.message)" - } + } if ($PsBoundParameters.ContainsKey("markForDeletion") -and ($PsBoundParameters.ContainsKey("id"))) { $jsonBody = '{"markForDeletion": true}' @@ -1722,11 +1807,11 @@ Function Get-VCFCredentialExpiry { $uri = "https://$sddcManager/v1/credentials/ui?includeExpiryOnly=true" $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers if ($PsBoundParameters.ContainsKey("resourceName")) { - $response.elements | Where-Object {$_.resource.resourceName -eq $resourceName} + $response.elements | Where-Object { $_.resource.resourceName -eq $resourceName } } elseif ($PsBoundParameters.ContainsKey("id")) { - $response.elements | Where-Object {$_.id -eq $id} + $response.elements | Where-Object { $_.id -eq $id } } elseif ($PsBoundParameters.ContainsKey("resourceType") ) { - $response.elements | Where-Object {$_.resource.resourceType -eq $resourceType} + $response.elements | Where-Object { $_.resource.resourceType -eq $resourceType } } else { $response.elements } @@ -1923,32 +2008,51 @@ Function New-VCFWorkloadDomain { The New-VCFWorkloadDomain cmdlet creates a workload domain from a JSON specification file. .EXAMPLE - New-VCFWorkloadDomain -json (Get-Content -Raw .\samples\domains\domainSpec.json) + New-VCFWorkloadDomain -json .\samples\domains\domainSpec.json This example shows how to create a workload domain from a JSON specification file. + .EXAMPLE + New-VCFWorkloadDomain -json .\samples\domains\domainSpec.json -validate + This example shows how to validate workload domain JSON specification file supplied. + .PARAMETER json Specifies the JSON specification to be used. + + .PARAMETER validate + Validate the JSON specification file. #> Param ( - [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$json + [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$json, + [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$validate ) Try { $jsonBody = validateJsonInput -json $json createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. - $response = Validate-WorkloadDomainSpec -json $jsonBody # Validate the JSON specification file. # the validation API does not currently support polling with a task ID - Start-Sleep -Seconds 5 - # Submit the job only if the JSON validation task completed with an executionStatus of COMPLETED and a resultStatus of SUCCEEDED. - if ($response.executionStatus -eq "COMPLETED" -and $response.resultStatus -eq "SUCCEEDED") { - Write-Output "Task validation completed successfully. Invoking Workload Domain Creation on SDDC Manager" - $uri = "https://$sddcManager/v1/domains" - $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody - Return $response - } else { - Write-Error "The validation task commpleted the run with the following problems:" - Write-Error $response.validationChecks.errorResponse.message + + if ( -Not $PsBoundParameters.ContainsKey("validate")) { + Do { + $response = Validate-WorkloadDomainSpec -json $jsonBody # Validate the JSON specification file. # the validation API does not currently support polling with a task ID + } + Until ($response.executionStatus -eq "COMPLETED") + # Submit the job only if the JSON validation task completed with an executionStatus of COMPLETED and a resultStatus of SUCCEEDED. + if ($response.executionStatus -eq "COMPLETED" -and $response.resultStatus -eq "SUCCEEDED") { + Write-Output "Task validation completed successfully. Invoking Workload Domain Creation on SDDC Manager" + $uri = "https://$sddcManager/v1/domains" + $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody + Return $response + } else { + Write-Error "The validation task completed the run with the following problems:" + Write-Output $response.validationChecks.errorResponse.message + } + } elseif ($PsBoundParameters.ContainsKey("validate")) { + Do { + $response = Validate-WorkloadDomainSpec -json $jsonBody # Validate the JSON specification file. # the validation API does not currently support polling with a task ID + } + Until ($response.executionStatus -eq "COMPLETED") + Return $response.validationChecks } } Catch { ResponseException -object $_ @@ -2550,12 +2654,36 @@ Function New-VCFCommissionedHost { [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$validate ) - if ($MyInvocation.InvocationName -eq "Commission-VCFHost") { - Write-Warning "Commission-VCFHost is deprecated and will be removed in a future release. Automatically redirecting to New-VCFCommissionedHost. Please refactor to New-VCFCommissionedHost at earliest opportunity." + $json_content = $json + $json_content = $json_content | ConvertFrom-Json + + # If the sample JSON payload from the SDDC Manager UO is used, transform to API specification. + if ($json.contains("hostfqdn")) { + $newjson_content = @() + foreach ($jsoninfo in $json_content.hostsSpec) { + $fqdn = $jsoninfo.hostfqdn + $networkPoolName = $jsoninfo.networkPoolName + $password = $jsoninfo.password + $username = $jsoninfo.username + $storageType = $jsoninfo.storageType + $networkId = Get-VCFNetworkPool -name $networkPoolName + $newjson_content += New-Object PSObject -Property @{ + 'fqdn' = $fqdn + 'networkPoolId' = $networkId.id + 'networkPoolName' = $networkPoolName + 'password' = $password + 'storageType' = $storageType + 'username' = $username + } + } + $jsonvalidation = ConvertTo-Json @($newjson_content) + $jsonBody = validateJsonInput -json $jsonvalidation + } else { + # If the JSON payload is already in the API specification, validate. + $jsonBody = validateJsonInput -json $json } Try { - $jsonBody = validateJsonInput -json $json createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. if ( -Not $PsBoundParameters.ContainsKey("validate")) { @@ -2573,7 +2701,8 @@ Function New-VCFCommissionedHost { $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody Return $response } else { - Write-Error "The validation task commpleted the run with the following problems: $($response.validationChecks.errorResponse.message)" + Write-Error "The validation task completed the run with the following problems:" + Write-Output $response.validationChecks.errorResponse } } elseif ($PsBoundParameters.ContainsKey("validate")) { $response = Validate-CommissionHostSpec -json $jsonBody # Validate the JSON specification file. @@ -2587,15 +2716,15 @@ Function New-VCFCommissionedHost { Write-Output "Task validation completed successfully." Return $response } else { - Write-Error "The validation task commpleted the run with the following problems: $($response.validationChecks.errorResponse.message)" + Write-Error "The validation task completed the run with the following problems:" + Write-Output $response.validationChecks.errorResponse } } } Catch { ResponseException -object $_ } } -New-Alias -name Commission-VCFHost -Value New-VCFCommissionedHost -Export-ModuleMember -Alias Commission-VCFHost -Function New-VCFCommissionedHost +Export-ModuleMember -Function New-VCFCommissionedHost Function Remove-VCFCommissionedHost { <# @@ -2617,10 +2746,6 @@ Function Remove-VCFCommissionedHost { [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$json ) - if ($MyInvocation.InvocationName -eq "Decommission-VCFHost") { - Write-Warning "Decommission-VCFHost is deprecated and will be removed in a future release. Automatically redirecting to Remove-VCFCommissionedHost. Please refactor to Remove-VCFCommissionedHost at earliest opportunity." - } - Try { $jsonBody = validateJsonInput -json $json createHeader # Set the Accept and Authorization headers. @@ -2632,8 +2757,7 @@ Function Remove-VCFCommissionedHost { ResponseException -object $_ } } -New-Alias -name Decommission-VCFHost -value Remove-VCFCommissionedHost -Export-ModuleMember -Alias Decommission-VCFHost -Function Remove-VCFCommissionedHost +Export-ModuleMember -Function Remove-VCFCommissionedHost #EndRegion APIs for managing Hosts @@ -3121,8 +3245,7 @@ Function Get-VCFNsxtCluster { ResponseException -object $_ } } -New-Alias -Name Get-VCFNsxManagerCluster -Value Get-VCFNsxtCluster -Export-ModuleMember -Function Get-VCFNsxtCluster -Alias Get-VCFNsxManagerCluster +Export-ModuleMember -Function Get-VCFNsxtCluster #EndRegion APIs for managing NSX Manager Clusters @@ -3170,8 +3293,7 @@ Function Get-VCFEdgeCluster { ResponseException -object $_ } } -New-Alias -Name Get-VCFNsxEdgeCluster -Value Get-VCFEdgeCluster -Export-ModuleMember -Function Get-VCFEdgeCluster -Alias Get-VCFNsxEdgeCluster +Export-ModuleMember -Function Get-VCFEdgeCluster Function New-VCFEdgeCluster { <# @@ -3220,7 +3342,7 @@ Function New-VCFEdgeCluster { $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody Return $response } else { - Write-Error "The validation task commpleted the run with the following error: $($response.validationChecks.errorResponse.message)" + Write-Error "The validation task completed the run with the following error: $($response.validationChecks.errorResponse.message)" } } elseif ($PsBoundParameters.ContainsKey("validate")) { $response = Validate-EdgeClusterSpec -json $jsonBody # Validate the JSON specification file. @@ -3234,15 +3356,14 @@ Function New-VCFEdgeCluster { Write-Output "Task validation completed successfully." Return $response } else { - Write-Error "The validation task commpleted the run with the following errors: $($response.validationChecks.errorResponse.message)" + Write-Error "The validation task completed the run with the following errors: $($response.validationChecks.errorResponse.message)" } } } Catch { ResponseException -object $_ } } -New-Alias -Name New-VCFNsxEdgeCluster -Value New-VCFEdgeCluster -Export-ModuleMember -Function New-VCFEdgeCluster -Alias New-VCFNsxEdgeCluster +Export-ModuleMember -Function New-VCFEdgeCluster #EndRegion APIs for managing NSX Edge Clusters @@ -3265,18 +3386,24 @@ Function Get-VCFPersonality { Get-VCFPersonality -id b4e3b2c4-31e8-4816-b1c5-801e848bef09 This example shows how to retrieve a vSphere Lifecycle Manager personality by unique ID. + .EXAMPLE + Get-VCFPersonality -name vSphere-8.0U1 + This example shows how to retrieve a vSphere Lifecycle Manager personality by name. + .PARAMETER id Specifies the unique ID of the vSphere Lifecycle Manager personality. #> Param ( - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$id + [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$id, + [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$name ) Try { createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. - if ( -not $PsBoundParameters.ContainsKey("id")) { + + if ((-Not $PsBoundParameters.ContainsKey('id')) -and (-Not $PsBoundParameters.ContainsKey('name'))) { $uri = "https://$sddcManager/v1/personalities" $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers $response.elements @@ -3286,6 +3413,16 @@ Function Get-VCFPersonality { $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers $response } + if ($PsBoundParameters.ContainsKey("name")) { + $uri = "https://$sddcManager/v1/personalities?personalityName=$name" + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers + # depending on the composition of the image, the response body may or may not contain elements + if (!$response.elements) { + $response + } else { + $response.elements + } + } } Catch { ResponseException -object $_ } @@ -3334,7 +3471,7 @@ Function New-VCFPersonality { createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. $uri = "https://$sddcManager/v1/personalities" - $response = Invoke-RestMethod -Method POST -ContentType 'application/json' -Uri $uri -Headers $headers -Body $body + $response = Invoke-RestMethod -Method POST -ContentType 'application/json' -Uri $uri -Headers $headers -Body $body $response } Catch { ResponseException -object $_ @@ -4261,27 +4398,49 @@ Function Get-VCFSystemPrecheckTask { Retrieves the status of a system level precheck task. .DESCRIPTION - The Get-VCFSystemPrecheckTask mdlet retrieves the status of a system level precheck task that can be polled + The Get-VCFSystemPrecheckTask cmdlet retrieves the status of a system level precheck task that can be polled and monitored. .EXAMPLE Get-VCFSystemPrecheckTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d This example shows how to retrieve the status of a system level precheck task by unique ID. + .EXAMPLE + Get-VCFSystemPrecheckTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d -failureOnly + This example shows how to retrieve only failed subtasks from the system level precheck task by unique ID. + .PARAMETER id Specifies the unique ID of the system level precheck task. + + .PARAMETER failureOnly + Specifies to return only the failed subtasks. + #> Param ( - [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$id + [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$id, + [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$failureOnly ) Try { createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. $uri = "https://$sddcManager/v1/system/prechecks/tasks/$id" - $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers -ContentType 'application/json' - $response + + Do { + # Keep checking until status is not IN_PROGRESS + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers -ContentType 'application/json' + Start-Sleep -Seconds 2 + } While ($response.status -eq "IN_PROGRESS") + + if ($response.status -eq "FAILED" -and $PsBoundParameters.ContainsKey("failureOnly")) { + $failed_task = $response.subTasks | Where-Object { $_.status -eq "FAILED" } + $failed_subtask = $failed_task.stages | Where-Object { $_.status -eq "FAILED" } + $failed_subtask + } else { + $response + } + } Catch { ResponseException -object $_ } @@ -4338,7 +4497,7 @@ Function Get-VCFTask { Try { $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers } Catch { - if ($_.Exception.Message -eq "The remote server returned an error: (404) Not Found.") { + if ($_.Exception.Message -eq "The remote server returned an error: (404) Not Found." -or $_.Exception.Message -eq "Response status code does not indicate success: 404 ().") { Write-Error "Task with ID $id not found." } else { ResponseException -object $_ @@ -4405,6 +4564,7 @@ Function checkVCFToken { $uri = "https://$sddcManager/v1/tokens/access-token/refresh" $response = Invoke-RestMethod -Method PATCH -Uri $uri -Headers $headers -Body $refreshToken $Global:accessToken = $response + createHeader # Set the Accept and Authorization headers with the new access token. } } } @@ -4583,10 +4743,10 @@ Function Start-VCFUpgrade { ) Try { - $jsonBody = validateJsonInput -json $json - createHeader # Set the Accept and Authorization headers. - checkVCFToken # Validate the access token and refresh, if necessary. - $uri = "https://$sddcManager/v1/upgrades" + $jsonBody = validateJsonInput -json $json + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/upgrades" $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody $response @@ -5065,8 +5225,7 @@ Function Set-VCFConfigurationNTP { $uri = "https://$sddcManager/v1/system/ntp-configuration/validations" $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody $response - } - else { + } else { $uri = "https://$sddcManager/v1/system/ntp-configuration" $response = Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody $response @@ -5141,7 +5300,7 @@ Function Set-VCFProxy { Param ( [Parameter (Mandatory = $true)] [ValidateSet("ENABLED", "DISABLED")] [ValidateNotNullOrEmpty()] [String]$status, [Parameter (Mandatory = $false, ParameterSetName = 'proxy')] [ValidateNotNullOrEmpty()] [String]$proxyHost, - [Parameter (Mandatory = $false, ParameterSetName = 'proxy')] [ValidateNotNullOrEmpty()] [ValidateRange(1,65535)] [Int]$proxyPort + [Parameter (Mandatory = $false, ParameterSetName = 'proxy')] [ValidateNotNullOrEmpty()] [ValidateRange(1, 65535)] [Int]$proxyPort ) Try { @@ -5746,7 +5905,7 @@ Function Remove-VCFIdentityProvider { #> Param ( - [Parameter (Mandatory = $true)] [ValidateSet("Embedded","Microsoft ADFS")] [String]$type, + [Parameter (Mandatory = $true)] [ValidateSet("Embedded", "Microsoft ADFS")] [String]$type, [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$domainName ) @@ -5755,10 +5914,10 @@ Function Remove-VCFIdentityProvider { createHeader # Set the Accept and Authorization headers. checkVCFToken # Validate the access token and refresh, if necessary. if ($type -eq "Embedded") { - $id = (Get-VCFIdentityProvider | Where-Object {$_.type -eq $type}).id + $id = (Get-VCFIdentityProvider | Where-Object { $_.type -eq $type }).id $uri = "https://$sddcManager/v1/identity-providers/$id/identity-sources/$domainName" } elseif ($type -eq "Microsoft ADFS") { - $id = (Get-VCFIdentityProvider | Where-Object {$_.type -eq $type}).id + $id = (Get-VCFIdentityProvider | Where-Object { $_.type -eq $type }).id $uri = "https://$sddcManager/v1/identity-providers/$id" } Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers # This API does not return a response. @@ -5796,7 +5955,7 @@ Function New-VCFIdentityProvider { #> Param ( - [Parameter (Mandatory = $true)] [ValidateSet("Embedded","Microsoft ADFS")] [String]$type, + [Parameter (Mandatory = $true)] [ValidateSet("Embedded", "Microsoft ADFS")] [String]$type, [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$json ) @@ -5806,7 +5965,7 @@ Function New-VCFIdentityProvider { checkVCFToken # Validate the access token and refresh, if necessary. if ($type -eq "Embedded") { $jsonBody = validateJsonInput -json $json - $id = (Get-VCFIdentityProvider | Where-Object {$_.type -eq $type}).id + $id = (Get-VCFIdentityProvider | Where-Object { $_.type -eq $type }).id $uri = "https://$sddcManager/v1/identity-providers/$id/identity-sources" } elseif ($type -eq "Microsoft ADFS") { $jsonBody = validateJsonInput -json $json @@ -5849,7 +6008,7 @@ Function Update-VCFIdentityProvider { #> Param ( - [Parameter (Mandatory = $true)] [ValidateSet("Embedded","Microsoft ADFS")] [String]$type, + [Parameter (Mandatory = $true)] [ValidateSet("Embedded", "Microsoft ADFS")] [String]$type, [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$domainName, [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$json ) @@ -5860,11 +6019,11 @@ Function Update-VCFIdentityProvider { checkVCFToken # Validate the access token and refresh, if necessary. if ($type -eq "Embedded") { $jsonBody = validateJsonInput -json $json - $id = (Get-VCFIdentityProvider | Where-Object {$_.type -eq $type}).id + $id = (Get-VCFIdentityProvider | Where-Object { $_.type -eq $type }).id $uri = "https://$sddcManager/v1/identity-providers/$id/identity-sources/$domainName" } elseif ($type -eq "Microsoft ADFS") { $jsonBody = validateJsonInput -json $json - $id = (Get-VCFIdentityProvider | Where-Object {$_.type -eq $type}).id + $id = (Get-VCFIdentityProvider | Where-Object { $_.type -eq $type }).id $uri = "https://$sddcManager/v1/identity-providers/$id" } Invoke-RestMethod -Method PATCH -Uri $uri -Headers $headers -ContentType 'application/json' -Body $jsonBody # This API does not return a response. @@ -5879,6 +6038,243 @@ Export-ModuleMember -Function Update-VCFIdentityProvider #EndRegion APIs for managing Identity Providers +#Region APIs for Compliance Service +Function Get-VCFComplianceConfiguration { + <# + .SYNOPSIS + Retrieves the list of all compliance configurations along with their applicable resource types and versions. + + .DESCRIPTION + The Get-VCFComplianceConfiguration cmdlet retrieves the list of all compliance configurations along with their applicable resource types and versions. + + .EXAMPLE + Get-VCFComplianceConfiguration + This example shows how to retrieve a list of all compliance configurations. + #> + + Try { + if ((Get-VCFManager -version) -ge '5.2.0') { + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/compliance-configurations" + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers + Return ($response).elements + } else { + Write-Warning "$msgVcfApiNotSupported $(Get-VCFManager -version)" + } + } Catch { + ResponseException -Object $_ + } +} +Export-ModuleMember -Function Get-VCFComplianceConfiguration + +Function Get-VCFComplianceStandard { + <# + .SYNOPSIS + Retrieves the list of all compliance standards and versions that are supported. + + .DESCRIPTION + The Get-VCFComplianceStandard cmdlet retrieves the the list of all compliance standards and versions that are supported. + + .EXAMPLE + Get-VCFComplianceStandard + This example shows how to retrieve a list of all compliance standards and versions. + #> + + Try { + if ((Get-VCFManager -version) -ge '5.2.0') { + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/compliance-standards" + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers + Return ($response).elements + } else { + Write-Warning "$msgVcfApiNotSupported $(Get-VCFManager -version)" + } + } Catch { + ResponseException -Object $_ + } +} +Export-ModuleMember -Function Get-VCFComplianceStandard + +Function Get-VCFComplianceHistory { + <# + .SYNOPSIS + Retrieves the history for all compliance audits that have been performed. + + .DESCRIPTION + The Get-VCFComplianceHistory cmdlet retrieves the history for all compliance audits that have been performed. + + .EXAMPLE + Get-VCFIdentityProvider + This example shows how to retrieve the history for all compliance audits that have been performed. + + .EXAMPLE + Get-VCFComplianceHistory + #> + + Try { + if ((Get-VCFManager -version) -ge '5.2.0') { + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/compliance-audits" + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers + Return ($response).elements + } else { + Write-Warning "$msgVcfApiNotSupported $(Get-VCFManager -version)" + } + } Catch { + ResponseException -Object $_ + } +} +Export-ModuleMember -Function Get-VCFComplianceHistory + +Function New-VCFCompliance { + <# + .SYNOPSIS + Performs a new compliance audit. + + .DESCRIPTION + The Get-VCFIdentityProvider cmdlet retrieves the history for all compliance audits. + + .EXAMPLE + New-VCFCompliance -resourceType "SDDC_MANAGER" -standardType "PCI" -standardVersion "4.0" -domainName "sfo-m01" + This example shows how to perform a new compliance audit. + + .PARAMETER resourceType + Specifies the resource type for the compliance audit. Please use Get-VCFComplianceConfiguration to see available options. + + .PARAMETER standardType + Specifies the compliance type for the compliance audit. Please use Get-VCFComplianceStandard to see available options. + + .PARAMETER standardVersion + Specifies the compliance version for the compliance audit. Please use Get-VCFComplianceStandard to see available options. + + .PARAMETER domainName + Specifies the name of the workload domain. + #> + + Param ( + [Parameter (Mandatory = $true)] [ValidateSet("SDDC_MANAGER")] [String]$resourceType = "SDDC_MANAGER", + [Parameter (Mandatory = $true)] [String]$standardType, + [Parameter (Mandatory = $true)] [String]$standardVersion, + [Parameter (Mandatory = $true)] [String]$domainName + ) + + $vcfWorkloadDomainDetails = Get-VCFWorkloadDomain -Name $domainName + + Try { + if ((Get-VCFManager -version) -ge '5.2.0') { + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/domains/$($vcfWorkloadDomainDetails.id)/compliance-audits" + + $spec = [Ordered]@{ + "standardType" = $standardType + "standardVersion" = $standardVersion + "complianceResourcesConfigurationSpec" = @( + @{ + "resources" = @( + @{ + "resourceType" = $resourceType + } + ) + } + ) + } + + $body = $spec | ConvertTo-Json -Depth 4 + + $response = Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -Body $body + Return $response + } else { + Write-Warning "$msgVcfApiNotSupported $(Get-VCFManager -version)" + } + } Catch { + ResponseException -Object $_ -body $body + } +} +Export-ModuleMember -Function New-VCFCompliance + +Function Get-VCFComplianceTask { + <# + .SYNOPSIS + Retrieves the compliance audit id and progress using the task id returned from the New-VCFCompliance operation. + + .DESCRIPTION + The Get-VCFComplianceTask cmdlet retrieves the compliance audit id and progress using the task id returned from the New-VCFCompliance operation. + + .EXAMPLE + Get-VCFComplianceTask -domainName "sfo-m01" -complianceTaskId "d22c47e0-8d38-43da-975b-938e7c59f4d6" + This example shows how to retrieve the compliance audit id and progress using the task id returned from the New-VCFCompliance operation. + + .PARAMETER domainName + SSpecifies the name of the workload domain. + + .PARAMETER complianceTaskId + Specifies the compliance task id returned from New-VCFCompliance. + #> + + Param ( + [Parameter (Mandatory = $true)] [String]$domainName, + [Parameter (Mandatory = $true)] [String]$complianceTaskId + ) + + $vcfWorkloadDomainDetails = Get-VCFWorkloadDomain -Name $domainName + + Try { + if ((Get-VCFManager -version) -ge '5.2.0') { + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/domains/$($vcfWorkloadDomainDetails.id)/compliance-audits/tasks/${complianceTaskId}" + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers + Return $response + } else { + Write-Warning "$msgVcfApiNotSupported $(Get-VCFManager -version)" + } + } Catch { + ResponseException -Object $_ + } +} +Export-ModuleMember -Function Get-VCFComplianceTask + +Function Get-VCFCompliance { + <# + .SYNOPSIS + Retrieves a specific compliance audit result. + + .DESCRIPTION + The Get-VCFCompliance cmdlet retrieves a specific compliance audit result. + + .EXAMPLE + Get-VCFCompliance -complianceAuditId "1758e972-8509-4dce-93d9-a303d7c35a41" + This example shows how to retrieve a specific compliance audit result. + + .PARAMETER complianceAuditId + Specifies the compliance task id returned from Get-VCFComplianceTask or Get-VCFComplianceHistory. + #> + + Param ( + [Parameter (Mandatory = $true)] [String]$complianceAuditId + ) + + Try { + if ((Get-VCFManager -version) -ge '5.2.0') { + createHeader # Set the Accept and Authorization headers. + checkVCFToken # Validate the access token and refresh, if necessary. + $uri = "https://$sddcManager/v1/compliance-audits/${complianceAuditId}/compliance-audit-items" + $response = Invoke-RestMethod -Method GET -Uri $uri -Headers $headers + Return ($response).elements + } else { + Write-Warning "$msgVcfApiNotSupported $(Get-VCFManager -version)" + } + } Catch { + ResponseException -Object $_ + } +} +Export-ModuleMember -Function Get-VCFCompliance +#EndRegion APIs for Compliance Service + #Region APIs for managing Validations (Not Exported) # The following functions are not exported since they are used internally by the cmdlets that manage the validations. @@ -5973,115 +6369,117 @@ Function Validate-EdgeClusterSpec { #EndRegion APIs for managing Validations (Not Exported) -#Region SoS Operations +#Region Utility Functions (Exported) Function Invoke-VCFCommand { <# .SYNOPSIS - Connects to the specified SDDC Manager using SSH and invoke SSH commands (SoS). + Run a command on SDDC Manager. .DESCRIPTION - The Invoke-VCFCommand cmdlet connects to the specified SDDC Manager over SSH using vcf user and subsequently - run elevated SOS commands using the root account. + The Invoke-VCFCommand cmdlet runs a command within the SDDC Manager appliance. .EXAMPLE - Invoke-VCFCommand -vcfpassword VMware1! -rootPassword VMware1! -sosOption general-health - This example will run and display the output of "/opt/vmware/sddc-support/sos --general-health". + Invoke-VCFCommand -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -vmUser vcf -vmPass VMw@re1! -command "echo Hello World." + This example runs the command provided on the SDDC Manager appliance as the vcf user. - .EXAMPLE - Invoke-VCFCommand -sosOption general-health - This example will ask for vcf and root password to the user and then run and display the output of "/opt/vmware/sddc-support/sos --general-health". + .PARAMETER server + The fully qualified domain name of the SDDC Manager. + + .PARAMETER user + The username to authenticate to the SDDC Manager. + + .PARAMETER pass + The password to authenticate to the SDDC Manager. + + .PARAMETER vmUser + The username to authenticate to the virtual machine. + + .PARAMETER vmPass + The password to authenticate to the virtual machine. + + .PARAMETER command + The command to run on the virtual machine. #> Param ( - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String] $vcfPassword, - [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String] $rootPassword, - [Parameter (Mandatory = $true)] [ValidateSet("general-health", "compute-health", "ntp-health", "password-health", "get-vcf-summary", "get-inventory-info", "get-host-ips", "get-vcf-services-summary")] [String] $sosOption + [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$server, + [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$user, + [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$pass, + [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$vmUser, + [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$vmPass, + [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$command ) - $poshSSH = Resolve-PSModule -moduleName "Posh-SSH" # POSH module is required, if not present skipping - if ($poshSSH -eq "ALREADY_IMPORTED" -or $poshSSH -eq "IMPORTED" -or $poshSSH -eq "INSTALLED_IMPORTED") { - # Expected sudo prompt from SDDC Manager for elevated commands. - $sudoPrompt = "[sudo] password for vcf" - # Validate if the SDDC Manager vcf password parameter is passed. If not, prompt the user and then build vcfCreds PSCredential object. - if ( -not $PsBoundParameters.ContainsKey("vcfPassword") ) { - Write-Output "Please provide the SDDC Manager vcf user password:" - $vcfSecuredPassword = Read-Host -AsSecureString - $vcfCred = New-Object System.Management.Automation.PSCredential ('vcf', $vcfSecuredPassword) - } else { - # Convert the clear text input password to secure string. - $vcfSecuredPassword = ConvertTo-SecureString $vcfPassword -AsPlainText -Force - # Build credential object. - $vcfCred = New-Object System.Management.Automation.PSCredential ('vcf', $vcfSecuredPassword) - } - # Validate if the SDDC Manager root password parameter is passed. If not, prompt the user and then build rootCreds PSCredential object. - if ( -not $PsBoundParameters.ContainsKey("rootPassword") ) { - Write-Output "Please provide the root credential to run elevated commands in SDDC Manager:" - $rootSecuredPassword = Read-Host -AsSecureString - $rootCred = New-Object System.Management.Automation.PSCredential ('root', $rootSecuredPassword) - } else { - # Convert the clear text input password to secure string. - $rootSecuredPassword = ConvertTo-SecureString $rootPassword -AsPlainText -Force - # Build credential object. - $rootCred = New-Object System.Management.Automation.PSCredential ('root', $rootSecuredPassword) - } - # Depending on the SoS command, there will be a different pattern to match at the end of the ssh stream output. - switch ($sosOption) { - "general-health" { $sosEndMessage = "For detailed report" } - "compute-health" { $sosEndMessage = "Health Check completed" } - "ntp-health" { $sosEndMessage = "For detailed report" } - "password-health" { $sosEndMessage = "completed" } - "get-inventory-info" { $sosEndMessage = "Health Check completed" } - "get-vcf-summary" { $sosEndMessage = "SOLUTIONS_MANAGER" } - "get-host-ips" { $sosEndMessage = "Health Check completed" } - "get-vcf-services-summary" { $sosEndMessage = "VCF SDDC Manager Uptime" } - } - - # Create SSH session to SDDC Manager using vcf user. By default, SSH is disabled for the root account. - Try { - $sessionSSH = New-SSHSession -Computer $sddcManager -Credential $vcfCred -AcceptKey - } Catch { - $errorString = ResponseException; Write-Error $errorString - } - if ($sessionSSH.Connected -eq "True") { - $stream = $SessionSSH.Session.CreateShellStream("PS-SSH", 0, 0, 0, 0, 1000) - # Build the SOS command to run. - $sshCommand = "sudo /opt/vmware/sddc-support/sos " + "--" + $sosOption - # Invoke the SSH stream command. - $outInvoke = Invoke-SSHStreamExpectSecureAction -ShellStream $stream -Command $sshCommand -ExpectString $sudoPrompt -SecureAction $rootCred.Password - if ($outInvoke) { - Write-Output "Running the remote SoS command. Output will display when the the run is completed. This might take a while, please wait..." - $stream.Expect($sosEndMessage) - } - # Destroy the connection previously established. - Remove-SSHSession -SessionId $sessionSSH.SessionId | Out-Null + $vcfWorkloadDomainDetails = Get-VCFWorkloadDomain | Where-Object { $_.type -eq "MANAGEMENT" } + $vcenterServerDetails = Get-VCFvCenter | Where-Object { $_.fqdn -eq $vcfWorkloadDomainDetails.vcenters.fqdn } + + if ($PSVersionTable.PSEdition -eq 'Core') { + if (!($status = Test-Connection -TargetName $vcfWorkloadDomainDetails.vcenters.fqdn -TcpPort 443 -Quiet)) { + Throw "Unable to connect to Management Domain vCenter Server ($vcfWorkloadDomainDetails.vcenters.fqdn)." } + } elseif ($PSVersionTable.PSEdition -eq 'Desktop') { + $OriginalProgressPreference = $Global:ProgressPreference; $Global:ProgressPreference = 'SilentlyContinue' + if (!($status = Test-NetConnection -ComputerName $vcfWorkloadDomainDetails.vcenters.fqdn -Port 443 -WarningAction SilentlyContinue)) { + $Global:ProgressPreference = $OriginalProgressPreference + Throw "Unable to connect to Management Domain vCenter Server ($vcfWorkloadDomainDetails.vcenters.fqdn)." + } + $Global:ProgressPreference = $OriginalProgressPreference + } + + $vcfDetail = Get-VCFRelease -domainId $vcfWorkloadDomainDetails.id + + if ( ($vcfDetail.version).Split("-")[0] -ge "4.5.0.0") { + $pscCredentialDetails = Get-VCFCredential | Where-Object { $_.resource.resourceType -eq "PSC" -and ($_.username).Split('@')[-1] -eq $vcfWorkloadDomainDetails.ssoName } } else { - Write-Error "PowerShell Module Posh-SSH staus is: $poshSSH. Posh-SSH is required to run this cmdlet. Please install the module and try again." + $pscCredentialDetails = Get-VCFCredential | Where-Object { $_.resource.resourceType -eq "PSC" } + } + + Connect-VIServer -Server $vcenterServerDetails.fqdn -User $pscCredentialDetails.username -Password $pscCredentialDetails.password -WarningAction SilentlyContinue | Out-Null + + if ($DefaultVIServer.Name -ne $vcenterServerDetails.fqdn) { + Throw "Unable to authenticate to Management Domain vCenter Server ($vcfWorkloadDomainDetails.vcenters.fqdn), check credentials and try again." + } + + Try { + $output = Invoke-VMScript -VM ($server.Split(".")[0]) -ScriptText $command -GuestUser $vmUser -GuestPassword $vmPass -Server $vcenterServerDetails.fqdn + $output + } Catch { + throw "Error executing command: $_" + } Finally { + Disconnect-VIServer -Server $vcenterServerDetails.fqdn -Confirm:$false -WarningAction SilentlyContinue | Out-Null } } Export-ModuleMember -Function Invoke-VCFCommand -#EndRegion SoS Operations + +#EndRegion Utility Functions (Exported) #Region Utility Functions (Not Exported) Function ResponseException { Param ( - [Parameter (Mandatory = $true)] [PSObject]$object + [Parameter (Mandatory = $true)] [PSObject]$object, + [Parameter (Mandatory = $false)] [PSObject]$body ) Write-Host "Script File: $($object.InvocationInfo.ScriptName) Line: $($object.InvocationInfo.ScriptLineNumber)" -ForegroundColor Red Write-Host "Relevant Command: $($object.InvocationInfo.Line.trim())" -ForegroundColor Red Write-Host "Target Uri: $($object.TargetObject.RequestUri.AbsoluteUri)" -ForegroundColor Red + if ($body -ne $null -and $body -ne "") { + Write-Host "Target Payload: $body" -ForegroundColor Red + } Write-Host "Exception Message: $($object.Exception.Message)" -ForegroundColor Red Write-Host "Error Message: $($object.ErrorDetails.Message)" -ForegroundColor Red } Function createHeader { - $Global:headers = @{"Accept" = "application/json" } - $Global:headers.Add("Authorization", "Bearer $accessToken") + $Global:headers = @{ + "Accept" = "application/json" + "Content-Type" = "application/json" + "Authorization" = "Bearer $accessToken" + } } Function createBasicAuthHeader { @@ -6188,7 +6586,7 @@ Function validateJsonInput { # Validate the JSON string format. Try { - $jsonPSobject = ConvertFrom-Json $ConfigJson -ErrorAction Stop; + $jsonPSobject = ConvertFrom-Json $ConfigJson -ErrorAction Stop; $jsonValid = $true; } Catch { $jsonValid = $false; @@ -6263,3 +6661,622 @@ Function Debug-CatchWriter { Export-ModuleMember -Function Debug-CatchWriter #EndRegion Useful Script Functions + + +#Region JSON Export Functions + +Function Export-VCFManagementDomainJsonSpec { + <# + .SYNOPSIS + 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. + + .DESCRIPTION + The Export-VCFManagementDomainJsonSpec cmdlet creates the JSON specification file using the Planning and Preparation workbook + to deploy a management domain. + + .EXAMPLE + Export-VCFManagementDomainJsonSpec -workbook .\pnp-workbook.xlsx -jsonPath .\domainSpec.json + This example creates a JSON deployment specification for a Management Domain using the Planning and Preparation Workbook. + + .PARAMETER workbook + The path to the Planning and Preparation Workbook (.xlsx) file. + + .PARAMETER jsonFile + The fully qualified path to the JSON specification file. + #> + + Param ( + [Parameter (Mandatory = $true)] [String]$workbook, + [Parameter (Mandatory = $true)] [String]$jsonPath + ) + + # Confirm the presence of ImportExcel module + if (!(Get-InstalledModule -name "ImportExcel" -MinimumVersion 7.8.5 -ErrorAction SilentlyContinue)) { + Write-Error "ImportExcel PowerShell Module Not Found. Please Install Manually" + } else { + Write-Output "ImportExcel PowerShell Module Found" + } + + $Global:vcfVersion = @("v4.3.x", "v4.4.x", "v4.5.x", "v5.0.x", "v5.1.x") + Try { + $module = "Management Domain JSON Spec" + Write-Output "Starting the Process of Generating the $module" + Write-Output "Opening the Excel Workbook: $workbook" + $pnpWorkbook = Open-ExcelPackage -Path $Workbook + + if ($pnpWorkbook.Workbook.Names["vcf_version"].Value -notin $vcfVersion) { + Write-Output "Planning and Preparation Workbook Provided Not Supported" + Break + } + + if ($pnpWorkbook.Workbook.Names["vcf_plus_result"].Value -eq "Included") { + $nsxtLicense = "" + $esxLicense = "" + $vsanLicense = "" + $vcenterLicense = "" + } else { + $nsxtLicense = $pnpWorkbook.Workbook.Names["nsxt_license"].Value + $esxLicense = $pnpWorkbook.Workbook.Names["esx_std_license"].Value + $vsanLicense = $pnpWorkbook.Workbook.Names["vsan_license"].Value + $vcenterLicense = $pnpWorkbook.Workbook.Names["vc_license"].Value + } + + # Check if management vm network is being used + if (!($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_cidr"]) -or $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_cidr"].Value -eq "Value Missing") { + $esxMgmtCidr = ($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_cidr"].Value.split("/"))[1] + $vmMgmtCidr = ($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_cidr"].Value.split("/"))[1] + } else { + $esxMgmtCidr = ($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_cidr"].Value.split("/"))[1] + $vmMgmtCidr = ($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_cidr"].Value.split("/"))[1] + } + + $esxManagmentMaskObject = ([IPAddress] ([Convert]::ToUInt64((("1" * $esxMgmtCidr) + ("0" * (32 - $esxMgmtCidr))), 2))) + $vmManagmentMaskObject = ([IPAddress] ([Convert]::ToUInt64((("1" * $vmMgmtCidr) + ("0" * (32 - $vmMgmtCidr))), 2))) + + $ntpServers = New-Object System.Collections.ArrayList + if ($pnpWorkbook.Workbook.Names["region_dns2_ip"].Value -eq "n/a") { + [Array]$ntpServers = $pnpWorkbook.Workbook.Names["region_dns1_ip"].Value + } else { + [Array]$ntpServers = $pnpWorkbook.Workbook.Names["region_dns1_ip"].Value, $pnpWorkbook.Workbook.Names["region_dns2_ip"].Value + } + + $dnsObject = @() + $dnsObject += [pscustomobject]@{ + 'domain' = $pnpWorkbook.Workbook.Names["region_ad_parent_fqdn"].Value + 'subdomain' = $pnpWorkbook.Workbook.Names["region_ad_child_fqdn"].Value + 'nameserver' = $pnpWorkbook.Workbook.Names["region_dns1_ip"].Value + 'secondaryNameserver' = $pnpWorkbook.Workbook.Names["region_dns2_ip"].Value + } + + $rootUserObject = @() + $rootUserObject += [pscustomobject]@{ + 'username' = "root" + 'password' = $pnpWorkbook.Workbook.Names["sddc_mgr_root_password"].Value + } + + $secondUserObject = @() + $secondUserObject += [pscustomobject]@{ + 'username' = "vcf" + 'password' = $pnpWorkbook.Workbook.Names["sddc_mgr_vcf_password"].Value + } + + $restApiUserObject = @() + $restApiUserObject += [pscustomobject]@{ + 'username' = "admin" + 'password' = $pnpWorkbook.Workbook.Names["sddc_mgr_admin_local_password"].Value + } + + $sddcManagerObject = @() + $sddcManagerObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["sddc_mgr_hostname"].Value + 'ipAddress' = $pnpWorkbook.Workbook.Names["sddc_mgr_ip"].Value + 'netmask' = $vmManagmentMaskObject.IPAddressToString + 'localUserPassword' = $pnpWorkbook.Workbook.Names["sddc_mgr_admin_local_password"].Value + rootUserCredentials = ($rootUserObject | Select-Object -Skip 0) + restApiCredentials = ($restApiUserObject | Select-Object -Skip 0) + secondUserCredentials = ($secondUserObject | Select-Object -Skip 0) + } + + $vmnics = New-Object System.Collections.ArrayList + [Array]$vmnics = $($pnpWorkbook.Workbook.Names["primary_vds_vmnics"].Value.Split(',')[0]), $($pnpWorkbook.Workbook.Names["primary_vds_vmnics"].Value.Split(',')[1]) + + $networks = New-Object System.Collections.ArrayList + if ($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_pg"].Value -eq "Value Missing") { + [Array]$networks = "MANAGEMENT", "VMOTION", "VSAN" + } else { + [Array]$networks = "MANAGEMENT", "VMOTION", "VSAN", "VM_MANAGEMENT" + } + + $vmotionIpObject = @() + $vmotionIpObject += [pscustomobject]@{ + 'startIpAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_pool_start_ip"].Value + 'endIpAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_pool_end_ip"].Value + } + + $vsanIpObject = @() + $vsanIpObject += [pscustomobject]@{ + 'startIpAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_pool_start_ip"].Value + 'endIpAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_pool_end_ip"].Value + } + + $vmotionMtu = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_mtu"].Value -as [string] + $vsanMtu = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_mtu"].Value -as [string] + $dvsMtu = [INT]$pnpWorkbook.Workbook.Names["primary_vds_mtu"].Value + + $networkObject = @() + $networkObject += [pscustomobject]@{ + 'networkType' = "MANAGEMENT" + 'subnet' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_cidr"].Value + 'vlanId' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vlan"].Value -as [string] + 'mtu' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_mtu"].Value -as [string] + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_gateway_ip"].Value + 'portGroupKey' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_pg"].Value + } + $networkObject += [pscustomobject]@{ + 'networkType' = "VMOTION" + 'subnet' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_cidr"].Value + includeIpAddressRanges = $vmotionIpObject + 'vlanId' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_vlan"].Value -as [string] + 'mtu' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_mtu"].Value -as [string] + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_gateway_ip"].Value + 'portGroupKey' = $pnpWorkbook.Workbook.Names["mgmt_az1_vmotion_pg"].Value + } + $networkObject += [pscustomobject]@{ + 'networkType' = "VSAN" + 'subnet' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_cidr"].Value + includeIpAddressRanges = $vsanIpObject + 'vlanId' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_vlan"].Value -as [string] + 'mtu' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_mtu"].Value -as [string] + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_gateway_ip"].Value + 'portGroupKey' = $pnpWorkbook.Workbook.Names["mgmt_az1_vsan_pg"].Value + } + if ($pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_pg"].Value -ne "Value Missing") { + $networkObject += [pscustomobject]@{ + 'networkType' = "VM_MANAGEMENT" + 'subnet' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_cidr"].Value + 'vlanId' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_vlan"].Value -as [string] + 'mtu' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_mtu"].Value -as [string] + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_gateway_ip"].Value + 'portGroupKey' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_vm_pg"].Value + } + } + + $nsxtManagerObject = @() + $nsxtManagerObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgra_hostname"].Value + 'ip' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgra_ip"].Value + } + if ($singleNSXTManager -eq "N") { + $nsxtManagerObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgrb_hostname"].Value + 'ip' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgrb_ip"].Value + } + $nsxtManagerObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgrc_hostname"].Value + 'ip' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgrc_ip"].Value + } + } + + $vlanTransportZoneObject = @() + $vlanTransportZoneObject += [pscustomobject]@{ + 'zoneName' = $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + "-tz-vlan01" + 'networkName' = "netName-vlan" + } + + $overlayTransportZoneObject = @() + $overlayTransportZoneObject += [pscustomobject]@{ + 'zoneName' = $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + "-tz-overlay01" + 'networkName' = "netName-overlay" + } + + $edgeNode01interfaces = @() + $edgeNode01interfaces += [pscustomobject]@{ + 'name' = $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + "-uplink01-tor1" + 'interfaceCidr' = $pnpWorkbook.Workbook.Names["mgmt_en1_edge_overlay_interface_ip_1_ip"].Value + } + $edgeNode01interfaces += [pscustomobject]@{ + 'name' = $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + "-uplink01-tor2" + 'interfaceCidr' = $pnpWorkbook.Workbook.Names["mgmt_en1_edge_overlay_interface_ip_2_ip"].Value + } + + $edgeNode02interfaces = @() + $edgeNode02interfaces += [pscustomobject]@{ + 'name' = $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + "-uplink01-tor1" + 'interfaceCidr' = $pnpWorkbook.Workbook.Names["mgmt_en2_edge_overlay_interface_ip_1_ip"].Value + } + $edgeNode02interfaces += [pscustomobject]@{ + 'name' = $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + "-uplink01-tor2" + 'interfaceCidr' = $pnpWorkbook.Workbook.Names["mgmt_en2_edge_overlay_interface_ip_2_ip"].Value + + } + + $edgeNodeObject = @() + $edgeNodeObject += [pscustomobject]@{ + 'edgeNodeName' = $pnpWorkbook.Workbook.Names["mgmt_en1_fqdn"].Value.Split(".")[0] + 'edgeNodeHostname' = $pnpWorkbook.Workbook.Names["mgmt_en1_fqdn"].Value + 'managementCidr' = $pnpWorkbook.Workbook.Names["input_mgmt_en1_ip"].Value + "/" + $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_cidr"].Value.Split("/")[-1] + 'edgeVtep1Cidr' = $pnpWorkbook.Workbook.Names["input_mgmt_en1_edge_overlay_interface_ip_1_ip"].Value + "/" + $pnpWorkbook.Workbook.Names["input_mgmt_edge_overlay_cidr"].Value.Split("/")[-1] + 'edgeVtep2Cidr' = $pnpWorkbook.Workbook.Names["input_mgmt_en1_edge_overlay_interface_ip_2_ip"].Value + "/" + $pnpWorkbook.Workbook.Names["input_mgmt_edge_overlay_cidr"].Value.Split("/")[-1] + interfaces = $edgeNode01interfaces + } + $edgeNodeObject += [pscustomobject]@{ + 'edgeNodeName' = $pnpWorkbook.Workbook.Names["mgmt_en2_fqdn"].Value.Split(".")[0] + 'edgeNodeHostname' = $pnpWorkbook.Workbook.Names["mgmt_en2_fqdn"].Value + 'managementCidr' = $pnpWorkbook.Workbook.Names["input_mgmt_en2_ip"].Value + "/" + $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_cidr"].Value.Split("/")[-1] + 'edgeVtep1Cidr' = $pnpWorkbook.Workbook.Names["input_mgmt_en2_edge_overlay_interface_ip_1_ip"].Value + "/" + $pnpWorkbook.Workbook.Names["input_mgmt_edge_overlay_cidr"].Value.Split("/")[-1] + 'edgeVtep2Cidr' = $pnpWorkbook.Workbook.Names["input_mgmt_en2_edge_overlay_interface_ip_2_ip"].Value + "/" + $pnpWorkbook.Workbook.Names["input_mgmt_edge_overlay_cidr"].Value.Split("/")[-1] + interfaces = $edgeNode02interfaces + } + + $edgeServicesObject = @() + $edgeServicesObject += [pscustomobject]@{ + 'tier0GatewayName' = $pnpWorkbook.Workbook.Names["mgmt_tier0_name"].Value + 'tier1GatewayName' = $pnpWorkbook.Workbook.Names["mgmt_tier1_name"].Value + } + + $bgpNeighboursObject = @() + $bgpNeighboursObject += [pscustomobject]@{ + 'neighbourIp' = $pnpWorkbook.Workbook.Names["input_mgmt_az1_tor1_peer_ip"].Value + 'autonomousSystem' = $pnpWorkbook.Workbook.Names["input_mgmt_az1_tor1_peer_asn"].Value + 'password' = $pnpWorkbook.Workbook.Names["input_mgmt_az1_tor1_peer_bgp_password"].Value + } + $bgpNeighboursObject += [pscustomobject]@{ + 'neighbourIp' = $pnpWorkbook.Workbook.Names["input_mgmt_az1_tor2_peer_ip"].Value + 'autonomousSystem' = $pnpWorkbook.Workbook.Names["input_mgmt_az1_tor2_peer_asn"].Value + 'password' = $pnpWorkbook.Workbook.Names["input_mgmt_az1_tor2_peer_bgp_password"].Value + } + + $nsxtEdgeObject = @() + $nsxtEdgeObject += [pscustomobject]@{ + 'edgeClusterName' = $pnpWorkbook.Workbook.Names["mgmt_ec_name"].Value + 'edgeRootPassword' = $pnpWorkbook.Workbook.Names["nsxt_en_root_password"].Value + 'edgeAdminPassword' = $pnpWorkbook.Workbook.Names["nsxt_en_admin_password"].Value + 'edgeAuditPassword' = $pnpWorkbook.Workbook.Names["nsxt_en_audit_password"].Value + 'edgeFormFactor' = $pnpWorkbook.Workbook.Names["mgmt_ec_formfactor"].Value + 'tier0ServicesHighAvailability' = "ACTIVE_ACTIVE" + 'asn' = $pnpWorkbook.Workbook.Names["mgmt_en_asn"].Value + edgeServicesSpecs = ($edgeServicesObject | Select-Object -Skip 0) + edgeNodeSpecs = $edgeNodeObject + bgpNeighbours = $bgpNeighboursObject + } + + $logicalSegmentsObject = @() + $logicalSegmentsObject += [pscustomobject]@{ + 'name' = $pnpWorkbook.Workbook.Names["reg_seg01_name"].Value + 'networkType' = "REGION_SPECIFIC" + } + $logicalSegmentsObject += [pscustomobject]@{ + 'name' = $pnpWorkbook.Workbook.Names["xreg_seg01_name"].Value + 'networkType' = "X_REGION" + } + + $nsxtObject = @() + $nsxtObject += [pscustomobject]@{ + 'nsxtManagerSize' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_mgr_formfactor"].Value.tolower() + nsxtManagers = $nsxtManagerObject + 'rootNsxtManagerPassword' = $pnpWorkbook.Workbook.Names["nsxt_lm_root_password"].Value + 'nsxtAdminPassword' = $pnpWorkbook.Workbook.Names["nsxt_lm_admin_password"].Value + 'nsxtAuditPassword' = $pnpWorkbook.Workbook.Names["nsxt_lm_audit_password"].Value + 'rootLoginEnabledForNsxtManager' = "true" + 'sshEnabledForNsxtManager' = "true" + overLayTransportZone = ($overlayTransportZoneObject | Select-Object -Skip 0) + vlanTransportZone = ($vlanTransportZoneObject | Select-Object -Skip 0) + 'vip' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_vip_ip"].Value + 'vipFqdn' = $pnpWorkbook.Workbook.Names["mgmt_nsxt_hostname"].Value + 'nsxtLicense' = $nsxtLicense + 'transportVlanId' = $pnpWorkbook.Workbook.Names["mgmt_az1_host_overlay_vlan"].Value -as [int] + } + + $excelvsanDedup = $pnpWorkbook.Workbook.Names["mgmt_vsan_dedup"].Value + if ($excelvsanDedup -eq "No") { + $vsanDedup = $false + } elseif ($excelvsanDedup -eq "Yes") { + $vsanDedup = $true + } + + if ($pnpWorkbook.Workbook.Names["mgmt_principal_storage_chosen"].Value -eq "vSAN-ESA") { + $ESAenabledtrueobject = @() + $ESAenabledtrueobject += [pscustomobject]@{ + 'enabled' = "true" + } + } else { + $ESAenabledtrueobject = @() + $ESAenabledtrueobject += [pscustomobject]@{ + 'enabled' = "false" + } + } + + $vsanObject = @() + if ($pnpWorkbook.Workbook.Names["mgmt_principal_storage_chosen"].Value -eq "vSAN-ESA") { + $vsanObject += [pscustomobject]@{ + 'vsanName' = "vsan-1" + 'licenseFile' = $vsanLicense + 'vsanDedup' = $vsanDedup + 'datastoreName' = $pnpWorkbook.Workbook.Names["mgmt_vsan_datastore"].Value + esaConfig = ($ESAenabledtrueobject | Select-Object -Skip 0) + } + } else { + $vsanObject += [pscustomobject]@{ + 'vsanName' = "vsan-1" + 'licenseFile' = $vsanLicense + 'vsanDedup' = $vsanDedup + 'datastoreName' = $pnpWorkbook.Workbook.Names["mgmt_vsan_datastore"].Value + } + } + $niocObject = @() + $niocObject += [pscustomobject]@{ + 'trafficType' = "VSAN" + 'value' = "HIGH" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "VMOTION" + 'value' = "LOW" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "VDP" + 'value' = "LOW" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "VIRTUALMACHINE" + 'value' = "HIGH" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "MANAGEMENT" + 'value' = "NORMAL" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "NFS" + 'value' = "LOW" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "HBR" + 'value' = "LOW" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "FAULTTOLERANCE" + 'value' = "LOW" + } + $niocObject += [pscustomobject]@{ + 'trafficType' = "ISCSI" + 'value' = "LOW" + } + + $dvsObject = @() + $dvsObject += [pscustomobject]@{ + 'mtu' = $dvsMtu + niocSpecs = $niocObject + 'dvsName' = $pnpWorkbook.Workbook.Names["primary_vds_name"].Value + 'vmnics' = $vmnics + 'networks' = $networks + } + + $vmFolderObject = @() + $vmFOlderObject += [pscustomobject]@{ + 'MANAGEMENT' = $pnpWorkbook.Workbook.Names["mgmt_mgmt_vm_folder"].Value + 'NETWORKING' = $pnpWorkbook.Workbook.Names["mgmt_nsx_vm_folder"].Value + 'EDGENODES' = $pnpWorkbook.Workbook.Names["mgmt_edge_vm_folder"].Value + } + + if (($pnpWorkbook.Workbook.Names["mgmt_evc_mode"].Value -eq "n/a") -or ($pnpWorkbook.Workbook.Names["mgmt_evc_mode"].Value -eq $null)) { + $evcMode = "" + } else { + $evcMode = $pnpWorkbook.Workbook.Names["mgmt_evc_mode"].Value + } + + $resourcePoolObject = @() + $resourcePoolObject += [pscustomobject]@{ + 'type' = "management" + 'name' = $pnpWorkbook.Workbook.Names["mgmt_mgmt_rp"].Value + 'cpuSharesLevel' = "high" + 'cpuSharesValue' = "0" -as [int] + 'cpuLimit' = "-1" -as [int] + 'cpuReservationExpandable' = $true + 'cpuReservationPercentage' = "0" -as [int] + 'memorySharesLevel' = "normal" + 'memorySharesValue' = "0" -as [int] + 'memoryLimit' = "-1" -as [int] + 'memoryReservationExpandable' = $true + 'memoryReservationPercentage' = "0" -as [int] + } + $resourcePoolObject += [pscustomobject]@{ + 'type' = "network" + 'name' = $pnpWorkbook.Workbook.Names["mgmt_nsx_rp"].Value + 'cpuSharesLevel' = "high" + 'cpuSharesValue' = "0" -as [int] + 'cpuLimit' = "-1" -as [int] + 'cpuReservationExpandable' = $true + 'cpuReservationPercentage' = "0" -as [int] + 'memorySharesLevel' = "normal" + 'memorySharesValue' = "0" -as [int] + 'memoryLimit' = "-1" -as [int] + 'memoryReservationExpandable' = $true + 'memoryReservationPercentage' = "0" -as [int] + } + $resourcePoolObject += [pscustomobject]@{ + 'type' = "compute" + 'name' = $pnpWorkbook.Workbook.Names["mgmt_user_edge_rp"].Value + 'cpuSharesLevel' = "normal" + 'cpuSharesValue' = "0" -as [int] + 'cpuLimit' = "-1" -as [int] + 'cpuReservationExpandable' = $true + 'cpuReservationPercentage' = "0" -as [int] + 'memorySharesLevel' = "normal" + 'memorySharesValue' = "0" -as [int] + 'memoryLimit' = "-1" -as [int] + 'memoryReservationExpandable' = $true + 'memoryReservationPercentage' = "0" -as [int] + } + $resourcePoolObject += [pscustomobject]@{ + 'type' = "compute" + 'name' = $pnpWorkbook.Workbook.Names["mgmt_user_vm_rp"].Value + 'cpuSharesLevel' = "normal" + 'cpuSharesValue' = "0" -as [int] + 'cpuLimit' = "-1" -as [int] + 'cpuReservationExpandable' = $true + 'cpuReservationPercentage' = "0" -as [int] + 'memorySharesLevel' = "normal" + 'memorySharesValue' = "0" -as [int] + 'memoryLimit' = "-1" -as [int] + 'memoryReservationExpandable' = $true + 'memoryReservationPercentage' = "0" -as [int] + } + + if ($pnpWorkbook.Workbook.Names["mgmt_consolidated_result"].Value -eq "Included") { + $clusterObject = @() + $clusterObject += [pscustomobject]@{ + vmFolders = ($vmFolderObject | Select-Object -Skip 0) + 'clusterName' = $pnpWorkbook.Workbook.Names["mgmt_cluster"].Value + 'clusterEvcMode' = $evcMode + resourcePoolSpecs = $resourcePoolObject + } + } else { + $clusterObject = @() + $clusterObject += [pscustomobject]@{ + vmFolders = ($vmFolderObject | Select-Object -Skip 0) + 'clusterName' = $pnpWorkbook.Workbook.Names["mgmt_cluster"].Value + 'clusterEvcMode' = $evcMode + } + } + + $ssoObject = @() + $ssoObject += [pscustomobject]@{ + 'ssoDomain' = 'vsphere.local' + } + + $pscObject = @() + $pscObject += [pscustomobject]@{ + pscSsoSpec = ($ssoObject | Select-Object -Skip 0) + 'adminUserSsoPassword' = $pnpWorkbook.Workbook.Names["administrator_vsphere_local_password"].Value + } + + $vcenterObject = @() + $vcenterObject += [pscustomobject]@{ + 'vcenterIp' = $pnpWorkbook.Workbook.Names["mgmt_vc_ip"].Value + 'vcenterHostname' = $pnpWorkbook.Workbook.Names["mgmt_vc_hostname"].Value + 'licenseFile' = $vcenterLicense + 'rootVcenterPassword' = $pnpWorkbook.Workbook.Names["vcenter_root_password"].Value + 'vmSize' = $pnpWorkbook.Workbook.Names["mgmt_vc_size"].Value.tolower() + } + + $hostCredentialsObject = @() + $hostCredentialsObject += [pscustomobject]@{ + 'username' = 'root' + 'password' = $pnpWorkbook.Workbook.Names["esxi_root_password"].Value + } + + $ipAddressPrivate01Object = @() + $ipAddressPrivate01Object += [pscustomobject]@{ + 'subnet' = $esxManagmentMaskObject.IPAddressToString + 'ipAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_host1_mgmt_ip"].Value + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_gateway_ip"].Value + } + + $ipAddressPrivate02Object = @() + $ipAddressPrivate02Object += [pscustomobject]@{ + 'subnet' = $esxManagmentMaskObject.IPAddressToString + 'ipAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_host2_mgmt_ip"].Value + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_gateway_ip"].Value + } + + $ipAddressPrivate03Object = @() + $ipAddressPrivate03Object += [pscustomobject]@{ + 'subnet' = $esxManagmentMaskObject.IPAddressToString + 'ipAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_host3_mgmt_ip"].Value + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_gateway_ip"].Value + } + + $ipAddressPrivate04Object = @() + $ipAddressPrivate04Object += [pscustomobject]@{ + 'subnet' = $esxManagmentMaskObject.IPAddressToString + 'ipAddress' = $pnpWorkbook.Workbook.Names["mgmt_az1_host4_mgmt_ip"].Value + 'gateway' = $pnpWorkbook.Workbook.Names["mgmt_az1_mgmt_gateway_ip"].Value + } + + $HostObject = @() + $HostObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_az1_host1_hostname"].Value + 'vSwitch' = $pnpWorkbook.Workbook.Names["mgmt_vss_switch"].Value + 'association' = $pnpWorkbook.Workbook.Names["mgmt_datacenter"].Value + credentials = ($hostCredentialsObject | Select-Object -Skip 0) + ipAddressPrivate = ($ipAddressPrivate01Object | Select-Object -Skip 0) + } + $HostObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_az1_host2_hostname"].Value + 'vSwitch' = $pnpWorkbook.Workbook.Names["mgmt_vss_switch"].Value + 'association' = $pnpWorkbook.Workbook.Names["mgmt_datacenter"].Value + credentials = ($hostCredentialsObject | Select-Object -Skip 0) + ipAddressPrivate = ($ipAddressPrivate02Object | Select-Object -Skip 0) + } + $HostObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_az1_host3_hostname"].Value + 'vSwitch' = $pnpWorkbook.Workbook.Names["mgmt_vss_switch"].Value + 'association' = $pnpWorkbook.Workbook.Names["mgmt_datacenter"].Value + credentials = ($hostCredentialsObject | Select-Object -Skip 0) + ipAddressPrivate = ($ipAddressPrivate03Object | Select-Object -Skip 0) + } + $HostObject += [pscustomobject]@{ + 'hostname' = $pnpWorkbook.Workbook.Names["mgmt_az1_host4_hostname"].Value + 'vSwitch' = $pnpWorkbook.Workbook.Names["mgmt_vss_switch"].Value + 'association' = $pnpWorkbook.Workbook.Names["mgmt_datacenter"].Value + credentials = ($hostCredentialsObject | Select-Object -Skip 0) + ipAddressPrivate = ($ipAddressPrivate04Object | Select-Object -Skip 0) + } + + $excluded = New-Object System.Collections.ArrayList + [Array]$excluded = "NSX-V" + + $ceipState = $pnpWorkbook.Workbook.Names["mgmt_ceip_status"].Value + if ($ceipState -eq "Yes") { + $ceipEnabled = "$true" + } else { + $ceipEnabled = "$false" + } + + $fipsState = $pnpWorkbook.Workbook.Names["mgmt_fips_status"].Value + if ($fipsState -eq "Yes") { + $fipsEnabled = "$true" + } else { + $fipsEnabled = "$false" + } + + $managementDomainObject = New-Object -TypeName psobject + $managementDomainObject | Add-Member -notepropertyname 'taskName' -notepropertyvalue "workflowconfig/workflowspec-ems.json" + $managementDomainObject | Add-Member -notepropertyname 'sddcId' -notepropertyvalue $pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value + $managementDomainObject | Add-Member -notepropertyname 'ceipEnabled' -notepropertyvalue $ceipEnabled + $managementDomainObject | Add-Member -notepropertyname 'fipsEnabled' -notepropertyvalue $fipsEnabled + $managementDomainObject | Add-Member -notepropertyname 'managementPoolName' -notepropertyvalue $pnpWorkbook.Workbook.Names["mgmt_az1_pool_name"].Value + $managementDomainObject | Add-Member -notepropertyname 'skipEsxThumbprintValidation' -notepropertyvalue $true + $managementDomainObject | Add-Member -notepropertyname 'esxLicense' -notepropertyvalue $esxLicense + $managementDomainObject | Add-Member -notepropertyname 'excludedComponents' -notepropertyvalue $excluded + $managementDomainObject | Add-Member -notepropertyname 'ntpServers' -notepropertyvalue $ntpServers + $managementDomainObject | Add-Member -notepropertyname 'dnsSpec' -notepropertyvalue ($dnsObject | Select-Object -Skip 0) + $managementDomainObject | Add-Member -notepropertyname 'sddcManagerSpec' -notepropertyvalue ($sddcManagerObject | Select-Object -Skip 0) + $managementDomainObject | Add-Member -notepropertyname 'networkSpecs' -notepropertyvalue $networkObject + $managementDomainObject | Add-Member -notepropertyname 'nsxtSpec' -notepropertyvalue ($nsxtObject | Select-Object -Skip 0) + $managementDomainObject | Add-Member -notepropertyname 'vsanSpec' -notepropertyvalue ($vsanObject | Select-Object -Skip 0) + $managementDomainObject | Add-Member -notepropertyname 'dvsSpecs' -notepropertyvalue $dvsObject + $managementDomainObject | Add-Member -notepropertyname 'clusterSpec' -notepropertyvalue ($clusterObject | Select-Object -Skip 0) + $managementDomainObject | Add-Member -notepropertyname 'pscSpecs' -notepropertyvalue $pscObject + $managementDomainObject | Add-Member -notepropertyname 'vcenterSpec' -notepropertyvalue ($vcenterObject | Select-Object -Skip 0) + $managementDomainObject | Add-Member -notepropertyname 'hostSpecs' -notepropertyvalue $hostObject + if ($pnpWorkbook.Workbook.Names["vcf_version"].Value -gt "v5.0.x") { + if ($pnpWorkbook.Workbook.Names["vcf_plus_chosen"].Value -eq "Included") { + $managementDomainObject | Add-Member -notepropertyname 'subscriptionLicensing' -notepropertyvalue "True" + } else { + $managementDomainObject | Add-Member -notepropertyname 'subscriptionLicensing' -notepropertyvalue "False" + } + } + + Write-Output "Exporting the $module to $($path)$($pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value)-domainSpec.json" + $managementDomainObject | ConvertTo-Json -Depth 12 | Out-File -Encoding UTF8 -FilePath $jsonPath"$($pnpWorkbook.Workbook.Names["mgmt_sddc_domain"].Value)-domainSpec.json" + Write-Output "Closing the Excel Workbook: $workbook" + Close-ExcelPackage $pnpWorkbook -NoSave -ErrorAction SilentlyContinue + Write-Output "Completed the Process of Generating the $module" + } Catch { + ResponseException -object $_ + } +} +Export-ModuleMember -Function Export-VCFManagementDomainJsonSpec + +#EndRegion JSON Export Functions diff --git a/README.md b/README.md index fa2dea021..ce339bd50 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,19 @@ [PowerShell Gallery][psgallery-module]   PowerShell Gallery Downloads -## Overview +## Project Archived + +The `PowerVCF` project has been archived and no further updates will be made. Please transition to [VCF.PowerCLI 9.x](https://developer.broadcom.com/powercli) to automate against SDDC Manager" + +## Historical Overview `PowerVCF` is an open source PowerShell Module for interacting with the [VMware Cloud Foundation][docs-vmware-cloud-foundation] public API. +For details on specific VMware Cloud Foundation versions supported by this module, please refer to the [documentation][docs-module]. + ## Documentation -Please refer to the [documentation][docs-module] for more information on how to use this module. +For detailed instructions on using this module, refer to the [documentation][docs-module]. ## Contributing @@ -40,7 +46,7 @@ You can also start a discussion on the GitHub [discussions][gh-discussions] area ## License -Copyright 2023 Broadcom. All Rights Reserved. +Copyright 2023-2024 Broadcom. All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/docs/community/index.md b/docs/community/index.md index 370f14414..bfe5561ae 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -4,11 +4,3 @@ This PowerShell module is the work of many contributors and the project team app Thank you for your interest in the project. Whether it's a bug report, enhancement, correction, or additional documentation, we greatly value feedback and contributions from our community. - -Name | Title | Role | GitHub | -------------------|------------------------------------------|--------------|------------------------------------------------------------------| -Brian O'Connell | Staff II Solutions Architect, VMware | Maintainer | [:fontawesome-brands-github:](https://github.com/LifeOfBrianOC) | -Gary Blake | Senior Staff Solutions Architect, VMware | Maintainer | [:fontawesome-brands-github:](https://github.com/GaryJBlake) | -Ken Gould | Staff II Solutions Architect, VMware | Maintainer | [:fontawesome-brands-github:](https://github.com/feardamhan) | -Ryan Johnson | Senior Staff Solutions Architect, VMware | Maintainer | [:fontawesome-brands-github:](https://github.com/tenthirtyam) | -Giuliano Bertello | Staff Solutions Architect, VMware | Collaborator | [:fontawesome-brands-github:](https://github.com/GiulianoBerteo) | diff --git a/docs/documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md b/docs/documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md index a42902f04..fd6188efb 100644 --- a/docs/documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md +++ b/docs/documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md @@ -72,4 +72,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/aria-suite/aria-operations/Get-VCFVrops.md b/docs/documentation/functions/aria-suite/aria-operations/Get-VCFVrops.md index 4d2aa0f9d..9f51c1bdd 100644 --- a/docs/documentation/functions/aria-suite/aria-operations/Get-VCFVrops.md +++ b/docs/documentation/functions/aria-suite/aria-operations/Get-VCFVrops.md @@ -56,4 +56,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/aria-suite/aria-operations/Set-VCFVropsConnection.md b/docs/documentation/functions/aria-suite/aria-operations/Set-VCFVropsConnection.md index 0d9d0d4bd..2865d9104 100644 --- a/docs/documentation/functions/aria-suite/aria-operations/Set-VCFVropsConnection.md +++ b/docs/documentation/functions/aria-suite/aria-operations/Set-VCFVropsConnection.md @@ -72,4 +72,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/aria-suite/aria-suite-lifecycle/New-VCFVrslcm.md b/docs/documentation/functions/aria-suite/aria-suite-lifecycle/New-VCFVrslcm.md index 60d446b9a..fb03c4600 100644 --- a/docs/documentation/functions/aria-suite/aria-suite-lifecycle/New-VCFVrslcm.md +++ b/docs/documentation/functions/aria-suite/aria-suite-lifecycle/New-VCFVrslcm.md @@ -78,4 +78,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/authentication/Connect-CloudBuilder.md b/docs/documentation/functions/authentication/Connect-CloudBuilder.md index e7d2d6705..be53cfb15 100644 --- a/docs/documentation/functions/authentication/Connect-CloudBuilder.md +++ b/docs/documentation/functions/authentication/Connect-CloudBuilder.md @@ -7,7 +7,7 @@ Requests an authentication token from a VMware Cloud Builder instance. ## Syntax ```powershell -Connect-CloudBuilder [-fqdn] [[-username] ] [[-password] ] [-skipCertificateCheck] [] +Connect-CloudBuilder [-fqdn] [[-username] ] [[-password] ] [[-credential] ] [-skipCertificateCheck] [] ``` ## Description @@ -23,10 +23,44 @@ The `Connect-CloudBuilder` cmdlet connects to the specified VMware Cloud Builder ### Example 1 ```powershell -Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin -password VMware1! +Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin -password VMw@re1! ``` -This example shows how to connect to the VMware Cloud Builder instance. +This example shows how to connect to the specified VMware Cloud Builder instance using a clear-text username and password. + +### Example 2 + +```powershell +$secureString = Read-Host -AsSecureString 'Password' +Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin -password $secureString +``` + +This example shows how to connect to the specified VMware Cloud Builder instance using a `SecureString` password. + +### Example 3 + +```powershell +$credential = Get-Credential +Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -credential $credential +``` + +This example shows how to connect to the specified VMware Cloud Builder instance using a PSCredential. + +### Example 4 + +```powershell +Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io -username admin +``` + +This example shows how to connect to the specified VMware Cloud Builder instance where the user will be prompted for a password. + +### Example 5 + +```powershell +Connect-CloudBuilder -fqdn sfo-cb01.sfo.rainpole.io +``` + +This example shows how to connect to the specified VMware Cloud Builder instance where the user will be prompted for a username and password. ## Parameters @@ -36,7 +70,7 @@ The fully qualified domain name of the VMware Cloud Builder instance. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: PSCredentialSet, UserNameAndPasswordSet Aliases: Required: True @@ -52,10 +86,10 @@ The username to authenticate to the VMware Cloud Builder instance. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UserNameAndPasswordSet Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False @@ -64,11 +98,13 @@ Accept wildcard characters: False ### -password -The password to authenticate to the VMware Cloud Builder instance. +The password to authenticate to the VMware Cloud Builder instance. This parameter takes either a string or a `SecureString` value. + +If not specified, the user will be prompted for the `SecureString` value. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UserNameAndPasswordSet Aliases: Required: False @@ -78,6 +114,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -credential + +Specifies to authenticate to the SDDC Manager instance using a PSCredential object. + +```yaml +Type: PSCredential +Parameter Sets: PSCredentialSet +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -skipCertificateCheck Switch to skip certificate check when connecting to the VMware Cloud Builder instance. @@ -96,4 +148,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/authentication/Request-VCFToken.md b/docs/documentation/functions/authentication/Request-VCFToken.md index 8fa5acb82..b58c230b2 100644 --- a/docs/documentation/functions/authentication/Request-VCFToken.md +++ b/docs/documentation/functions/authentication/Request-VCFToken.md @@ -7,7 +7,7 @@ Requests an authentication token from SDDC Manager. ## Syntax ```powershell -Request-VCFToken [-fqdn] [[-username] ] [[-password] ] [-skipCertificateCheck] [] +Request-VCFToken [-fqdn] [[-username] ] [[-password] ] [[-credential] ] [-skipCertificateCheck] [] ``` ## Description @@ -22,15 +22,41 @@ The `Request-VCFToken` cmdlet connects to the specified SDDC Manager and request Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username administrator@vsphere.local -password VMw@re1! ``` -This example shows how to connect to SDDC Manager to request API access and refresh tokens. +This example shows how to connect to the specified SDDC Manager using a clear-text username and password. ### Example 2 ```powershell -Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username admin@local -password VMw@re1!VMw@re1! +$secureString = Read-Host -AsSecureString 'Password' +Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username admin@local -password $secureString ``` -This example shows how to connect to SDDC Manager using local account `admin@local`. +This example shows how to connect to the specified SDDC Manager instance using a `SecureString` password. + +### Example 3 + +```powershell +$credential = Get-Credential +Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -credential $credential +``` + +This example shows how to connect to the specified SDDC Manager instance using a PSCredential. + +### Example 4 + +```powershell +Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io -username admin@local +``` + +This example shows how to connect to the SDDC Manager instance where the user will be prompted for a password. + +### Example 5 + +```powershell +Request-VCFToken -fqdn sfo-vcf01.sfo.rainpole.io +``` + +This example shows how to connect to the specified SDDC Manager instance where the user will be prompted for a username and password. ## Parameters @@ -40,7 +66,7 @@ The fully qualified domain name or IP Address of the SDDC Manager instance. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: PSCredentialSet, UserNameAndPasswordSet Aliases: Required: True @@ -56,10 +82,10 @@ The username to authenticate to the SDDC Manager instance. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UserNameAndPasswordSet Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False @@ -68,11 +94,13 @@ Accept wildcard characters: False ### -password -The password to authenticate to the SDDC Manager instance. +The password to authenticate to the SDDC Manager instance. This parameter takes either a string or a `SecureString` value. + +If not specified, the user will be prompted for the `SecureString` value. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UserNameAndPasswordSet Aliases: Required: False @@ -82,6 +110,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -credential + +Specifies to authenticate to the SDDC Manager instance using a PSCredential object. + +```yaml +Type: PSCredential +Parameter Sets: PSCredentialSet +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -skipCertificateCheck Switch to skip certificate check when connecting to the SDDC Manager instance. @@ -100,4 +144,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md b/docs/documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md index c287ecd3a..3556c5912 100644 --- a/docs/documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md +++ b/docs/documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md @@ -80,4 +80,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/avns/Get-VCFApplicationVirtualNetwork.md b/docs/documentation/functions/avns/Get-VCFApplicationVirtualNetwork.md index 45affa521..b7f593199 100644 --- a/docs/documentation/functions/avns/Get-VCFApplicationVirtualNetwork.md +++ b/docs/documentation/functions/avns/Get-VCFApplicationVirtualNetwork.md @@ -76,4 +76,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/backup-restore/Get-VCFRestoreTask.md b/docs/documentation/functions/backup-restore/Get-VCFRestoreTask.md index b3ff322bb..fc49e16e3 100644 --- a/docs/documentation/functions/backup-restore/Get-VCFRestoreTask.md +++ b/docs/documentation/functions/backup-restore/Get-VCFRestoreTask.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/backup-restore/Set-VCFBackupConfiguration.md b/docs/documentation/functions/backup-restore/Set-VCFBackupConfiguration.md index 2192df5e1..7405d05b8 100644 --- a/docs/documentation/functions/backup-restore/Set-VCFBackupConfiguration.md +++ b/docs/documentation/functions/backup-restore/Set-VCFBackupConfiguration.md @@ -50,4 +50,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/backup-restore/Start-VCFRestore.md b/docs/documentation/functions/backup-restore/Start-VCFRestore.md index e232ceaa1..803ba6885 100644 --- a/docs/documentation/functions/backup-restore/Start-VCFRestore.md +++ b/docs/documentation/functions/backup-restore/Start-VCFRestore.md @@ -60,4 +60,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/bundles/Get-VCFBundle.md b/docs/documentation/functions/bundles/Get-VCFBundle.md index 01ffd83d5..86386aa2f 100644 --- a/docs/documentation/functions/bundles/Get-VCFBundle.md +++ b/docs/documentation/functions/bundles/Get-VCFBundle.md @@ -72,4 +72,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/bundles/Request-VCFBundle.md b/docs/documentation/functions/bundles/Request-VCFBundle.md index 7c24bc945..71c48bc8f 100644 --- a/docs/documentation/functions/bundles/Request-VCFBundle.md +++ b/docs/documentation/functions/bundles/Request-VCFBundle.md @@ -48,4 +48,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/bundles/Start-VCFBundleUpload.md b/docs/documentation/functions/bundles/Start-VCFBundleUpload.md index 440290517..91dc112b2 100644 --- a/docs/documentation/functions/bundles/Start-VCFBundleUpload.md +++ b/docs/documentation/functions/bundles/Start-VCFBundleUpload.md @@ -54,4 +54,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/ceip/Set-VCFCeip.md b/docs/documentation/functions/ceip/Set-VCFCeip.md index 65057ca15..fc1ab854a 100644 --- a/docs/documentation/functions/ceip/Set-VCFCeip.md +++ b/docs/documentation/functions/ceip/Set-VCFCeip.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Get-VCFCertificate.md b/docs/documentation/functions/certificates/Get-VCFCertificate.md index fc9d3355b..f3c263b43 100644 --- a/docs/documentation/functions/certificates/Get-VCFCertificate.md +++ b/docs/documentation/functions/certificates/Get-VCFCertificate.md @@ -84,4 +84,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Get-VCFCertificateAuthority.md b/docs/documentation/functions/certificates/Get-VCFCertificateAuthority.md index 16b3558b4..75eb9155e 100644 --- a/docs/documentation/functions/certificates/Get-VCFCertificateAuthority.md +++ b/docs/documentation/functions/certificates/Get-VCFCertificateAuthority.md @@ -60,4 +60,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Get-VCFCertificateCsr.md b/docs/documentation/functions/certificates/Get-VCFCertificateCsr.md index f06ab9469..812b9f161 100644 --- a/docs/documentation/functions/certificates/Get-VCFCertificateCsr.md +++ b/docs/documentation/functions/certificates/Get-VCFCertificateCsr.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Remove-VCFCertificateAuthority.md b/docs/documentation/functions/certificates/Remove-VCFCertificateAuthority.md index 6b3123901..a07a80678 100644 --- a/docs/documentation/functions/certificates/Remove-VCFCertificateAuthority.md +++ b/docs/documentation/functions/certificates/Remove-VCFCertificateAuthority.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Request-VCFCertificate.md b/docs/documentation/functions/certificates/Request-VCFCertificate.md index 23cbfb7ba..99af83ceb 100644 --- a/docs/documentation/functions/certificates/Request-VCFCertificate.md +++ b/docs/documentation/functions/certificates/Request-VCFCertificate.md @@ -74,4 +74,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Request-VCFCertificateCsr.md b/docs/documentation/functions/certificates/Request-VCFCertificateCsr.md index f8c0e838c..aba65e360 100644 --- a/docs/documentation/functions/certificates/Request-VCFCertificateCsr.md +++ b/docs/documentation/functions/certificates/Request-VCFCertificateCsr.md @@ -70,4 +70,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Set-VCFCertificate.md b/docs/documentation/functions/certificates/Set-VCFCertificate.md index 87cfd6d3e..f69d74f1c 100644 --- a/docs/documentation/functions/certificates/Set-VCFCertificate.md +++ b/docs/documentation/functions/certificates/Set-VCFCertificate.md @@ -66,4 +66,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Set-VCFMicrosoftCa.md b/docs/documentation/functions/certificates/Set-VCFMicrosoftCa.md index b2baf79c3..5aec25bfe 100644 --- a/docs/documentation/functions/certificates/Set-VCFMicrosoftCa.md +++ b/docs/documentation/functions/certificates/Set-VCFMicrosoftCa.md @@ -92,4 +92,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/certificates/Set-VCFOpensslCa.md b/docs/documentation/functions/certificates/Set-VCFOpensslCa.md index e19f54aea..7289976c4 100644 --- a/docs/documentation/functions/certificates/Set-VCFOpensslCa.md +++ b/docs/documentation/functions/certificates/Set-VCFOpensslCa.md @@ -124,4 +124,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/clusters/Get-VCFCluster.md b/docs/documentation/functions/clusters/Get-VCFCluster.md index d672e1d41..218d6ca8c 100644 --- a/docs/documentation/functions/clusters/Get-VCFCluster.md +++ b/docs/documentation/functions/clusters/Get-VCFCluster.md @@ -100,4 +100,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/clusters/Get-VCFClusterValidation.md b/docs/documentation/functions/clusters/Get-VCFClusterValidation.md index 01d6ff4d5..561abceec 100644 --- a/docs/documentation/functions/clusters/Get-VCFClusterValidation.md +++ b/docs/documentation/functions/clusters/Get-VCFClusterValidation.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/clusters/New-VCFCluster.md b/docs/documentation/functions/clusters/New-VCFCluster.md index bac17b7b7..50422d1d2 100644 --- a/docs/documentation/functions/clusters/New-VCFCluster.md +++ b/docs/documentation/functions/clusters/New-VCFCluster.md @@ -129,4 +129,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/clusters/Remove-VCFCluster.md b/docs/documentation/functions/clusters/Remove-VCFCluster.md index 735de5a14..93203c663 100644 --- a/docs/documentation/functions/clusters/Remove-VCFCluster.md +++ b/docs/documentation/functions/clusters/Remove-VCFCluster.md @@ -49,4 +49,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/clusters/Set-VCFCluster.md b/docs/documentation/functions/clusters/Set-VCFCluster.md index d767f79cf..ca3dc410e 100644 --- a/docs/documentation/functions/clusters/Set-VCFCluster.md +++ b/docs/documentation/functions/clusters/Set-VCFCluster.md @@ -109,4 +109,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/compliance/Get-VCFCompliance.md b/docs/documentation/functions/compliance/Get-VCFCompliance.md new file mode 100644 index 000000000..7b15002e9 --- /dev/null +++ b/docs/documentation/functions/compliance/Get-VCFCompliance.md @@ -0,0 +1,73 @@ +# Get-VCFCompliance + +## Synopsis + +Retrieves a specific compliance audit result. + +## Syntax + +```powershell +Get-VCFCompliance [-complianceAuditId] [] +``` + +## Description + +The `Get-VCFCompliance` cmdlet retrieves a specific compliance audit result. + +## Examples + +### Example 1 + +```powershell +Get-VCFCompliance -complianceAuditId "1758e972-8509-4dce-93d9-a303d7c35a41" + +resourceType : SDDC_MANAGER +resourceName : sfo-vcf01.sfo.rainpole.io +configurationId : 1602 +configurationTitle : Install Security Patches and updates for SDDC Manager. +isConfigurationRecommendedByStandard : True +citationReference : 6.3.3, 6.3.3 Bullet 1, 6.3.3 Bullet 2 +recommendedValue : TRUE +actualValue : FALSE +complianceStatus : NON_COMPLIANT +remediationStep : To apply patches and updates to SDDC Manager/Cloud Foundation follow the guidance in the Lifecycle Management section found at the URL below. + https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/vcf-lifecycle/GUID-B384B08D-3652-45E2-8AA9-AF53066F5F70.html +complianceAuditStatus : SUCCEEDED + +resourceType : SDDC_MANAGER +resourceName : sfo-vcf01.sfo.rainpole.io +configurationId : 1601 +configurationTitle : SDDC Manager components must use an authoritative time source. +isConfigurationRecommendedByStandard : True +citationReference : 10.6.1, 10.6.2 Bullet 6, 10.6.2, 10.6.2 Bullet 2, 10.6.2 Bullet 3 +recommendedValue : TRUE +actualValue : TRUE +complianceStatus : COMPLIANT +remediationStep : From the SDDC Manager UI, navigate to Administration >> Network Settings >> NTP Configuration Click 'Edit'. Review the information on updating NTP and click 'Next'. Review the + prerequisites and click 'Next'. Enter new authoritative NTP servers in the text box and click 'Save'. +complianceAuditStatus : SUCCEEDED +``` + +This example shows how to retrieve a specific compliance audit result. + +## Parameters + +### -complianceAuditId + +Specified the compliance task returned from `Get-VCFComplianceTask` or `Get-VCFComplianceHistory`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +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). diff --git a/docs/documentation/functions/compliance/Get-VCFComplianceConfiguration.md b/docs/documentation/functions/compliance/Get-VCFComplianceConfiguration.md new file mode 100644 index 000000000..c16a1aa3c --- /dev/null +++ b/docs/documentation/functions/compliance/Get-VCFComplianceConfiguration.md @@ -0,0 +1,37 @@ +# Get-VCFComplianceConfiguration + +## Synopsis + +Retrieves the list of all compliance configurations along with their applicable resource types and versions. + +## Syntax + +```powershell +Get-VCFComplianceConfiguration +``` + +## Description + +The `Get-VCFComplianceConfiguration` cmdlet retrieves the list of all compliance configurations along with their applicable resource types and versions. + +## Examples + +### Example 1 + +```powershell +Get-VCFComplianceConfiguration + +configurationId configurationTitle complianceResourceStandardConfigurationDetails +--------------- ------------------ ---------------------------------------------- +1600 Verify SDDC Manager backup. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1601 SDDC Manager components must use an authoritative time source. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1602 Install Security Patches and updates for SDDC Manager. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1603 Use an SSL certificate issued by a trusted certificate authority on the SDDC Manager. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1604 Do not expose SDDC Manager directly on the Internet. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1605 Assign least privileges to users and service accounts in SDDC Manager. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1607 Dedicate an account for downloading updates and patches in SDDC Manager. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1608 SDDC Manager must be deployed with FIPS mode enabled. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +1609 SDDC Manager must schedule automatic password rotation. {@{resourceType=SDDC_MANAGER; resourceVersion=5.2.0.0; standardConfigurationDetails=System.Object[]}} +``` + +This example shows how to retrieve a list of all compliance configurations. diff --git a/docs/documentation/functions/compliance/Get-VCFComplianceHistory.md b/docs/documentation/functions/compliance/Get-VCFComplianceHistory.md new file mode 100644 index 000000000..86105befe --- /dev/null +++ b/docs/documentation/functions/compliance/Get-VCFComplianceHistory.md @@ -0,0 +1,53 @@ +# Get-VCFComplianceHistory + +## Synopsis + +Retrieves the history for all compliance audits that have been performed. + +## Syntax + +```powershell +Get-VCFComplianceHistory +``` + +## Description + +The `Get-VCFComplianceHistory` cmdlet retrieves the history for all compliance audits that have been performed. + +## Examples + +### Example 1 + +```powershell +Get-VCFComplianceHistory + +id : b0762a5f-c575-4e1a-a002-de32e9e9426d +creationTimestamp : 7/30/2024 9:31:45 PM +completionTimestamp : 7/30/2024 9:31:47 PM +standardType : PCI +standardVersion : 4.0 +domainId : 6ca52d6b-9292-4baf-ab97-75c3a74d4bf2 +configurationEvaluationStatus : SOME_EVALUATED +configurationEvaluationStatusDetails : [1605, 1604] configurations were skipped in audit. Follow the audit procedure to run them manually. +compliantStatus : PARTIALLY_COMPLIANT +totalConfigurationsEvaluated : 9 +numberOfNonCompliantConfigurations : 5 +numberOfSkippedConfigurations : 2 +numberOfAuditItems : 9 + +id : e2b165c7-0118-4064-9f41-33639fb37195 +creationTimestamp : 7/30/2024 10:52:31 PM +completionTimestamp : 7/30/2024 10:52:32 PM +standardType : PCI +standardVersion : 4.0 +domainId : 6ca52d6b-9292-4baf-ab97-75c3a74d4bf2 +configurationEvaluationStatus : SOME_EVALUATED +configurationEvaluationStatusDetails : [1605, 1604] configurations were skipped in audit. Follow the audit procedure to run them manually. +compliantStatus : PARTIALLY_COMPLIANT +totalConfigurationsEvaluated : 9 +numberOfNonCompliantConfigurations : 5 +numberOfSkippedConfigurations : 2 +numberOfAuditItems : 9 +``` + +This example shows how to retrieve the history for all compliance audits that have been performed. diff --git a/docs/documentation/functions/compliance/Get-VCFComplianceStandard.md b/docs/documentation/functions/compliance/Get-VCFComplianceStandard.md new file mode 100644 index 000000000..d10942122 --- /dev/null +++ b/docs/documentation/functions/compliance/Get-VCFComplianceStandard.md @@ -0,0 +1,29 @@ +# Get-VCFComplianceStandard + +## Synopsis + +Retrieves the list of all compliance audit standards and versions that are supported. + +## Syntax + +```powershell +Get-VCFComplianceConfiguration +``` + +## Description + +The `Get-VCFComplianceStandard` cmdlet retrieves the the list of all compliance audit standards and versions that are supported. + +## Examples + +### Example 1 + +```powershell +Get-VCFComplianceStandard + +standardType standardVersions +------------ ---------------- +PCI {4.0} +``` + +This example shows how to retrieve a list of all compliance audit standards and versions. diff --git a/docs/documentation/functions/compliance/Get-VCFComplianceTask.md b/docs/documentation/functions/compliance/Get-VCFComplianceTask.md new file mode 100644 index 000000000..2985f7eba --- /dev/null +++ b/docs/documentation/functions/compliance/Get-VCFComplianceTask.md @@ -0,0 +1,67 @@ +# Get-VCFComplianceTask + +## Synopsis + +Retrieves the list of all compliance configurations along with their applicable resource types and versions. + +## Syntax + +```powershell +Get-VCFComplianceTask [-domainName] [-complianceTaskId] [] +``` + +## Description + +The `Get-VCFComplianceTask` cmdlet retrieves the compliance audit id and progress using the task id returned from the `New-VCFCompliance` operation. + +## Examples + +### Example 1 + +```powershell +Get-VCFComplianceTask -domainName "sfo-m01" -complianceTaskId "d22c47e0-8d38-43da-975b-938e7c59f4d6" + +id status complianceAuditId +-- ------ ----------------- +d22c47e0-8d38-43da-975b-938e7c59f4d6 SUCCESSFUL 1758e972-8509-4dce-93d9-a303d7c35a41 +``` + +This example shows how to retrieve the compliance audit id and progress using the task id returned from the `New-VCFCompliance` operation. + +## Parameters + +### -domainName + +Specifies the name of the workload domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -complianceTaskId + +Specifies the compliance task returned from `New-VCFCompliance`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +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). diff --git a/docs/documentation/functions/compliance/New-VCFCompliance.md b/docs/documentation/functions/compliance/New-VCFCompliance.md new file mode 100644 index 000000000..a1a85334d --- /dev/null +++ b/docs/documentation/functions/compliance/New-VCFCompliance.md @@ -0,0 +1,95 @@ +# New-VCFCompliance + +## Synopsis + +Performs a new compliance audit. + +## Syntax + +```powershell +New-VCFCompliance [-resourceType] [-standardType] [-standardVersion] [-domainName] [] +``` + +## Description + +The `New-VCFWorkloadDomain` cmdlet performs a new compliance audit. + +## Examples + +### Example 1 + +```powershell +New-VCFCompliance -resourceType "SDDC_MANAGER" -standardType "PCI" -standardVersion "4.0" -domainName "sfo-m01" +``` + +This example shows how to perform a new compliance audit. + +## Parameters + +### -resourceType + +Specifies the resource type for the compliance audit. Please use `Get-VCFComplianceConfiguration` to see available options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -standardType + +Specifies the compliance type for the compliance audit. Please use `Get-VCFComplianceStandard` to see available options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -standardVersion + +Specifies the compliance version for the compliance audit. Please use `Get-VCFComplianceStandard` to see available options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -domainName + +Specifies the name of the workload domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +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). diff --git a/docs/documentation/functions/credentials/Get-VCFCredential.md b/docs/documentation/functions/credentials/Get-VCFCredential.md index efce693b5..01277546a 100644 --- a/docs/documentation/functions/credentials/Get-VCFCredential.md +++ b/docs/documentation/functions/credentials/Get-VCFCredential.md @@ -114,4 +114,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/credentials/Get-VCFCredentialExpiry.md b/docs/documentation/functions/credentials/Get-VCFCredentialExpiry.md index 8947aff56..b04483d85 100644 --- a/docs/documentation/functions/credentials/Get-VCFCredentialExpiry.md +++ b/docs/documentation/functions/credentials/Get-VCFCredentialExpiry.md @@ -100,4 +100,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/credentials/Get-VCFCredentialTask.md b/docs/documentation/functions/credentials/Get-VCFCredentialTask.md index abf027db8..f8effbb87 100644 --- a/docs/documentation/functions/credentials/Get-VCFCredentialTask.md +++ b/docs/documentation/functions/credentials/Get-VCFCredentialTask.md @@ -100,4 +100,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/credentials/Restart-VCFCredentialTask.md b/docs/documentation/functions/credentials/Restart-VCFCredentialTask.md index cab748719..f469ebc02 100644 --- a/docs/documentation/functions/credentials/Restart-VCFCredentialTask.md +++ b/docs/documentation/functions/credentials/Restart-VCFCredentialTask.md @@ -60,4 +60,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/credentials/Set-VCFCredential.md b/docs/documentation/functions/credentials/Set-VCFCredential.md index 32065b2c5..8d8d1cd82 100644 --- a/docs/documentation/functions/credentials/Set-VCFCredential.md +++ b/docs/documentation/functions/credentials/Set-VCFCredential.md @@ -68,4 +68,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/credentials/Set-VCFCredentialAutoRotatePolicy.md b/docs/documentation/functions/credentials/Set-VCFCredentialAutoRotatePolicy.md index 9248d897d..5b52d40af 100644 --- a/docs/documentation/functions/credentials/Set-VCFCredentialAutoRotatePolicy.md +++ b/docs/documentation/functions/credentials/Set-VCFCredentialAutoRotatePolicy.md @@ -135,4 +135,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/credentials/Stop-VCFCredentialTask.md b/docs/documentation/functions/credentials/Stop-VCFCredentialTask.md index 136cbd778..2826cf68b 100644 --- a/docs/documentation/functions/credentials/Stop-VCFCredentialTask.md +++ b/docs/documentation/functions/credentials/Stop-VCFCredentialTask.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/depots/Get-VCFDepotCredential.md b/docs/documentation/functions/depots/Get-VCFDepotCredential.md index 4584b9dfc..5d3c3912d 100644 --- a/docs/documentation/functions/depots/Get-VCFDepotCredential.md +++ b/docs/documentation/functions/depots/Get-VCFDepotCredential.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/depots/Set-VCFDepotCredential.md b/docs/documentation/functions/depots/Set-VCFDepotCredential.md index fa79d8c77..11d45e8bf 100644 --- a/docs/documentation/functions/depots/Set-VCFDepotCredential.md +++ b/docs/documentation/functions/depots/Set-VCFDepotCredential.md @@ -84,4 +84,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/dns-ntp/Get-VCFConfigurationDNSValidation.md b/docs/documentation/functions/dns-ntp/Get-VCFConfigurationDNSValidation.md index 1bf551f8d..163cc8d29 100644 --- a/docs/documentation/functions/dns-ntp/Get-VCFConfigurationDNSValidation.md +++ b/docs/documentation/functions/dns-ntp/Get-VCFConfigurationDNSValidation.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/dns-ntp/Get-VCFConfigurationNTPValidation.md b/docs/documentation/functions/dns-ntp/Get-VCFConfigurationNTPValidation.md index 752a0260d..cc273de4e 100644 --- a/docs/documentation/functions/dns-ntp/Get-VCFConfigurationNTPValidation.md +++ b/docs/documentation/functions/dns-ntp/Get-VCFConfigurationNTPValidation.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/dns-ntp/Set-VCFConfigurationDNS.md b/docs/documentation/functions/dns-ntp/Set-VCFConfigurationDNS.md index 7c314cfd0..cb22b602d 100644 --- a/docs/documentation/functions/dns-ntp/Set-VCFConfigurationDNS.md +++ b/docs/documentation/functions/dns-ntp/Set-VCFConfigurationDNS.md @@ -74,4 +74,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/dns-ntp/Set-VCFConfigurationNTP.md b/docs/documentation/functions/dns-ntp/Set-VCFConfigurationNTP.md index 1cd58a415..2e59bf82a 100644 --- a/docs/documentation/functions/dns-ntp/Set-VCFConfigurationNTP.md +++ b/docs/documentation/functions/dns-ntp/Set-VCFConfigurationNTP.md @@ -74,4 +74,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/domains/Get-VCFWorkloadDomain.md b/docs/documentation/functions/domains/Get-VCFWorkloadDomain.md index 8f1cc9591..ea39d30fd 100644 --- a/docs/documentation/functions/domains/Get-VCFWorkloadDomain.md +++ b/docs/documentation/functions/domains/Get-VCFWorkloadDomain.md @@ -100,4 +100,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/domains/New-VCFWorkloadDomain.md b/docs/documentation/functions/domains/New-VCFWorkloadDomain.md index 2931271af..94786da9b 100644 --- a/docs/documentation/functions/domains/New-VCFWorkloadDomain.md +++ b/docs/documentation/functions/domains/New-VCFWorkloadDomain.md @@ -19,7 +19,7 @@ The `New-VCFWorkloadDomain` cmdlet creates a workload domain from a JSON specifi ### Example 1 ```powershell -New-VCFWorkloadDomain -json (Get-Content -Raw .\samples\domains\domainSpec.json) +New-VCFWorkloadDomain -json .\samples\domains\domainSpec.json ``` This example shows how to create a workload domain from a JSON specification file. @@ -35,6 +35,14 @@ This example shows how to create a workload domain from a JSON specification fil --8<-- "./samples/domains/isolatedDomainSpec.json" ``` +### Example 2 + +```powershell +New-VCFWorkloadDomain -json .\samples\domains\domainSpec.json -validate +``` + +This example shows how to validate the workload domain JSON specification file. + ## Parameters ### -json @@ -53,6 +61,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -validate + +Specifies to validate the JSON specification file. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/domains/Remove-VCFWorkloadDomain.md b/docs/documentation/functions/domains/Remove-VCFWorkloadDomain.md index 8d685ab9c..f5d3e7d42 100644 --- a/docs/documentation/functions/domains/Remove-VCFWorkloadDomain.md +++ b/docs/documentation/functions/domains/Remove-VCFWorkloadDomain.md @@ -49,4 +49,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/domains/Set-VCFWorkloadDomain.md b/docs/documentation/functions/domains/Set-VCFWorkloadDomain.md index c0207e153..dd71336ce 100644 --- a/docs/documentation/functions/domains/Set-VCFWorkloadDomain.md +++ b/docs/documentation/functions/domains/Set-VCFWorkloadDomain.md @@ -49,4 +49,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/federation/Get-VCFFederationTask.md b/docs/documentation/functions/federation/Get-VCFFederationTask.md index a55841fdf..5694df95c 100644 --- a/docs/documentation/functions/federation/Get-VCFFederationTask.md +++ b/docs/documentation/functions/federation/Get-VCFFederationTask.md @@ -48,4 +48,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/federation/Join-VCFFederation.md b/docs/documentation/functions/federation/Join-VCFFederation.md index ed6459f07..25d94c5e2 100644 --- a/docs/documentation/functions/federation/Join-VCFFederation.md +++ b/docs/documentation/functions/federation/Join-VCFFederation.md @@ -54,4 +54,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/federation/New-VCFFederationInvite.md b/docs/documentation/functions/federation/New-VCFFederationInvite.md index 4eae5eb6e..03095cde4 100644 --- a/docs/documentation/functions/federation/New-VCFFederationInvite.md +++ b/docs/documentation/functions/federation/New-VCFFederationInvite.md @@ -64,4 +64,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/federation/Set-VCFFederation.md b/docs/documentation/functions/federation/Set-VCFFederation.md index f47430d18..b0f1b4595 100644 --- a/docs/documentation/functions/federation/Set-VCFFederation.md +++ b/docs/documentation/functions/federation/Set-VCFFederation.md @@ -54,4 +54,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/hosts/Get-VCFHost.md b/docs/documentation/functions/hosts/Get-VCFHost.md index d563433a0..85160737a 100644 --- a/docs/documentation/functions/hosts/Get-VCFHost.md +++ b/docs/documentation/functions/hosts/Get-VCFHost.md @@ -124,4 +124,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/hosts/New-VCFCommissionedHost.md b/docs/documentation/functions/hosts/New-VCFCommissionedHost.md index 411d0ae18..8b1cb334c 100644 --- a/docs/documentation/functions/hosts/New-VCFCommissionedHost.md +++ b/docs/documentation/functions/hosts/New-VCFCommissionedHost.md @@ -22,14 +22,20 @@ The `New-VCFCommissionedHost` cmdlet commissions a list of ESXi hosts. New-VCFCommissionedHost -json (Get-Content -Raw .\samples\hosts\commissionHostsSpec.json) ``` -This example shows how to commission a list of ESXi hosts using a JSON specification file. +This example shows how to commission a list of ESXi hosts using a JSON specification files. -???+ example "Sample JSON: Commission ESXi Host(s)" +???+ example "Sample JSON: Commission ESXi Host(s) from SDDC Manager API JSON Spec" ```json --8<-- "./samples/hosts/commissionHostsSpec.json" ``` +???+ example "Sample JSON: Commission ESXi Host(s) from the JSON Spec Provided by the SDDC Manager UI" + + ```json + --8<-- "./samples/hosts/ui-commissionHostsSpec.json" + ``` + ### Example 2 ```powershell @@ -74,4 +80,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/hosts/Remove-VCFCommissionedHost.md b/docs/documentation/functions/hosts/Remove-VCFCommissionedHost.md index 5bdcc1890..a219c11b5 100644 --- a/docs/documentation/functions/hosts/Remove-VCFCommissionedHost.md +++ b/docs/documentation/functions/hosts/Remove-VCFCommissionedHost.md @@ -50,4 +50,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/iam/Get-VCFUser.md b/docs/documentation/functions/iam/Get-VCFUser.md index ab97991ff..24aa3fb1c 100644 --- a/docs/documentation/functions/iam/Get-VCFUser.md +++ b/docs/documentation/functions/iam/Get-VCFUser.md @@ -92,4 +92,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/iam/New-VCFGroup.md b/docs/documentation/functions/iam/New-VCFGroup.md index 0150a3ee5..54b496387 100644 --- a/docs/documentation/functions/iam/New-VCFGroup.md +++ b/docs/documentation/functions/iam/New-VCFGroup.md @@ -76,4 +76,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/iam/New-VCFServiceUser.md b/docs/documentation/functions/iam/New-VCFServiceUser.md index 3f3148f81..6ae5aec39 100644 --- a/docs/documentation/functions/iam/New-VCFServiceUser.md +++ b/docs/documentation/functions/iam/New-VCFServiceUser.md @@ -60,4 +60,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/iam/New-VCFUser.md b/docs/documentation/functions/iam/New-VCFUser.md index 8b164f4b6..7b02bd6b6 100644 --- a/docs/documentation/functions/iam/New-VCFUser.md +++ b/docs/documentation/functions/iam/New-VCFUser.md @@ -60,4 +60,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/iam/Remove-VCFUser.md b/docs/documentation/functions/iam/Remove-VCFUser.md index 99c490f77..e258bc714 100644 --- a/docs/documentation/functions/iam/Remove-VCFUser.md +++ b/docs/documentation/functions/iam/Remove-VCFUser.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/idp/Get-VCFIdentityProvider.md b/docs/documentation/functions/idp/Get-VCFIdentityProvider.md index c6298084d..d94d37de7 100644 --- a/docs/documentation/functions/idp/Get-VCFIdentityProvider.md +++ b/docs/documentation/functions/idp/Get-VCFIdentityProvider.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/idp/New-VCFIdentityProvider.md b/docs/documentation/functions/idp/New-VCFIdentityProvider.md index 33e4a163c..af9e94b96 100644 --- a/docs/documentation/functions/idp/New-VCFIdentityProvider.md +++ b/docs/documentation/functions/idp/New-VCFIdentityProvider.md @@ -80,4 +80,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/idp/Remove-VCFIdentityProvider.md b/docs/documentation/functions/idp/Remove-VCFIdentityProvider.md index c772036bc..80bd3bcc2 100644 --- a/docs/documentation/functions/idp/Remove-VCFIdentityProvider.md +++ b/docs/documentation/functions/idp/Remove-VCFIdentityProvider.md @@ -68,4 +68,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/idp/Update-VCFIdentityProvider.md b/docs/documentation/functions/idp/Update-VCFIdentityProvider.md index 5bb794080..8143e43e4 100644 --- a/docs/documentation/functions/idp/Update-VCFIdentityProvider.md +++ b/docs/documentation/functions/idp/Update-VCFIdentityProvider.md @@ -84,4 +84,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/json-export/Export-VCFManagementDomainJsonSpec.md b/docs/documentation/functions/json-export/Export-VCFManagementDomainJsonSpec.md new file mode 100644 index 000000000..4a401d815 --- /dev/null +++ b/docs/documentation/functions/json-export/Export-VCFManagementDomainJsonSpec.md @@ -0,0 +1,63 @@ +# Export-VCFManagementDomainJsonSpec + +## Synopsis + +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. + +## Syntax + +```powershell +Export-VCFManagementDomainJsonSpec [[-workbook] ] [[-jsonPath] ] [] +``` + +## Description + +The `Export-VCFManagementDomainJsonSpec` cmdlet Generates a JSON file from the VCF Planning & Preparation Workbook to perform a VCF bringup. + +## Examples + +### Example 1 + +```powershell +Export-VCFManagementDomainJsonSpec -workbook vcf-pnp.xlsx -jsonPath ./ +``` + +This example will open the Planning & Preparation workbook and extract the required data to create a bringup JSON. + +## Parameters + +### -workbook + +Specifies the path to the Planning & Preparation Excel workbook. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -jsonPath + +Specifies the output path for the json file. JSON file name will be 'management_domain_name-domainSpec.json' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +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). diff --git a/docs/documentation/functions/licenses/Get-VCFLicenseKey.md b/docs/documentation/functions/licenses/Get-VCFLicenseKey.md index 439c3a76e..1b3ba78bc 100644 --- a/docs/documentation/functions/licenses/Get-VCFLicenseKey.md +++ b/docs/documentation/functions/licenses/Get-VCFLicenseKey.md @@ -100,4 +100,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/licenses/New-VCFLicenseKey.md b/docs/documentation/functions/licenses/New-VCFLicenseKey.md index 4ab5fce42..15f13f304 100644 --- a/docs/documentation/functions/licenses/New-VCFLicenseKey.md +++ b/docs/documentation/functions/licenses/New-VCFLicenseKey.md @@ -76,4 +76,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/licenses/Remove-VCFLicenseKey.md b/docs/documentation/functions/licenses/Remove-VCFLicenseKey.md index ff122994d..0ecb212d0 100644 --- a/docs/documentation/functions/licenses/Remove-VCFLicenseKey.md +++ b/docs/documentation/functions/licenses/Remove-VCFLicenseKey.md @@ -48,4 +48,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/network-pools/Add-VCFNetworkIPPool.md b/docs/documentation/functions/network-pools/Add-VCFNetworkIPPool.md index 484ecaea9..91046b08a 100644 --- a/docs/documentation/functions/network-pools/Add-VCFNetworkIPPool.md +++ b/docs/documentation/functions/network-pools/Add-VCFNetworkIPPool.md @@ -92,4 +92,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/network-pools/Get-VCFNetworkIPPool.md b/docs/documentation/functions/network-pools/Get-VCFNetworkIPPool.md index 76416530a..fac64d388 100644 --- a/docs/documentation/functions/network-pools/Get-VCFNetworkIPPool.md +++ b/docs/documentation/functions/network-pools/Get-VCFNetworkIPPool.md @@ -68,4 +68,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/network-pools/Get-VCFNetworkPool.md b/docs/documentation/functions/network-pools/Get-VCFNetworkPool.md index 34c0282f3..fa0a96a0b 100644 --- a/docs/documentation/functions/network-pools/Get-VCFNetworkPool.md +++ b/docs/documentation/functions/network-pools/Get-VCFNetworkPool.md @@ -76,4 +76,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/network-pools/New-VCFNetworkPool.md b/docs/documentation/functions/network-pools/New-VCFNetworkPool.md index 2a5ce5a64..ec9540688 100644 --- a/docs/documentation/functions/network-pools/New-VCFNetworkPool.md +++ b/docs/documentation/functions/network-pools/New-VCFNetworkPool.md @@ -50,4 +50,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/network-pools/Remove-VCFNetworkIPPool.md b/docs/documentation/functions/network-pools/Remove-VCFNetworkIPPool.md index 22ab5324e..902d21dd1 100644 --- a/docs/documentation/functions/network-pools/Remove-VCFNetworkIPPool.md +++ b/docs/documentation/functions/network-pools/Remove-VCFNetworkIPPool.md @@ -92,4 +92,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/network-pools/Remove-VCFNetworkPool.md b/docs/documentation/functions/network-pools/Remove-VCFNetworkPool.md index a61bdad1e..823d772f2 100644 --- a/docs/documentation/functions/network-pools/Remove-VCFNetworkPool.md +++ b/docs/documentation/functions/network-pools/Remove-VCFNetworkPool.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/nsx/nsx-edge-clusters/Get-VCFEdgeCluster.md b/docs/documentation/functions/nsx/nsx-edge-clusters/Get-VCFEdgeCluster.md index 3db5f2d47..9cef3fb5b 100644 --- a/docs/documentation/functions/nsx/nsx-edge-clusters/Get-VCFEdgeCluster.md +++ b/docs/documentation/functions/nsx/nsx-edge-clusters/Get-VCFEdgeCluster.md @@ -56,4 +56,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/nsx/nsx-edge-clusters/New-VCFEdgeCluster.md b/docs/documentation/functions/nsx/nsx-edge-clusters/New-VCFEdgeCluster.md index c79a4e53b..e65e887f0 100644 --- a/docs/documentation/functions/nsx/nsx-edge-clusters/New-VCFEdgeCluster.md +++ b/docs/documentation/functions/nsx/nsx-edge-clusters/New-VCFEdgeCluster.md @@ -78,4 +78,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/nsx/nsx-managers/Get-VCFNsxtCluster.md b/docs/documentation/functions/nsx/nsx-managers/Get-VCFNsxtCluster.md index 4e9ffc755..765550cab 100644 --- a/docs/documentation/functions/nsx/nsx-managers/Get-VCFNsxtCluster.md +++ b/docs/documentation/functions/nsx/nsx-managers/Get-VCFNsxtCluster.md @@ -64,4 +64,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/other/Invoke-VCFCommand.md b/docs/documentation/functions/other/Invoke-VCFCommand.md new file mode 100644 index 000000000..9a9d519f6 --- /dev/null +++ b/docs/documentation/functions/other/Invoke-VCFCommand.md @@ -0,0 +1,127 @@ +# Invoke-VCFCommand + +## Synopsis + +Run a command on SDDC Manager. + +## Syntax + +```powershell +Invoke-VCFCommand [-server] [-user] [-pass] [-vmUser] [-vmPass] [-command] [] +``` + +## Description + +The `Invoke-VCFCommand` cmdlet runs a command within the SDDC Manager appliance. + +## Examples + +### Example 1 + +```powershell +Invoke-VCFCommand -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -vmUser vcf -vmPass VMw@re1! -command "echo Hello World." +``` + +This example runs the command provided on the SDDC Manager appliance as the `vcf` user. + +## Parameters + +### -server + +The fully qualified domain name of the SDDC Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -user + +The username to authenticate to the SDDC Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -pass + +The password to authenticate to the SDDC Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmUser + +The username to authenticate to the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vmPass + +The password to authenticate to the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -command + +The command to run on the virtual machine. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +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). diff --git a/docs/documentation/functions/personalities/Get-VCFPersonality.md b/docs/documentation/functions/personalities/Get-VCFPersonality.md index cacefa0fa..1c7fe7c28 100644 --- a/docs/documentation/functions/personalities/Get-VCFPersonality.md +++ b/docs/documentation/functions/personalities/Get-VCFPersonality.md @@ -7,7 +7,7 @@ Retrieves the vSphere Lifecycle Manager personalities. ## Syntax ```powershell -Get-VCFPersonality [[-id] ] [] +Get-VCFPersonality [[-id] ] [[-name] ] [] ``` ## Description @@ -32,6 +32,15 @@ Get-VCFPersonality -id b4e3b2c4-31e8-4816-b1c5-801e848bef09 This example shows how to retrieve a vSphere Lifecycle Manager personality by unique ID. +### Example 3 + +```powershell +Get-VCFPersonality -name vSphere-8.0U1 +``` + +This example shows how to retrieve a vSphere Lifecycle Manager personality by unique name. + + ## Parameters ### -id @@ -50,6 +59,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -name + +Specifies the unique name of the vSphere Lifecycle Manager personality. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/personalities/New-VCFPersonality.md b/docs/documentation/functions/personalities/New-VCFPersonality.md index 18f0cc42b..ee5effb8f 100644 --- a/docs/documentation/functions/personalities/New-VCFPersonality.md +++ b/docs/documentation/functions/personalities/New-VCFPersonality.md @@ -76,4 +76,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/pscs/Get-VCFPSC.md b/docs/documentation/functions/pscs/Get-VCFPSC.md index 7a732005d..ae5a73afc 100644 --- a/docs/documentation/functions/pscs/Get-VCFPSC.md +++ b/docs/documentation/functions/pscs/Get-VCFPSC.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/releases/Get-VCFRelease.md b/docs/documentation/functions/releases/Get-VCFRelease.md index 4f072068c..bbb9c8daa 100644 --- a/docs/documentation/functions/releases/Get-VCFRelease.md +++ b/docs/documentation/functions/releases/Get-VCFRelease.md @@ -256,4 +256,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc-managers/Get-VCFManager.md b/docs/documentation/functions/sddc-managers/Get-VCFManager.md index 0128b3492..4775b42b6 100644 --- a/docs/documentation/functions/sddc-managers/Get-VCFManager.md +++ b/docs/documentation/functions/sddc-managers/Get-VCFManager.md @@ -124,4 +124,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Get-CloudBuilderSDDC.md b/docs/documentation/functions/sddc/Get-CloudBuilderSDDC.md index 8040e643b..f46fac683 100644 --- a/docs/documentation/functions/sddc/Get-CloudBuilderSDDC.md +++ b/docs/documentation/functions/sddc/Get-CloudBuilderSDDC.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Get-CloudBuilderSDDCValidation.md b/docs/documentation/functions/sddc/Get-CloudBuilderSDDCValidation.md index 72ef9964c..338f509e3 100644 --- a/docs/documentation/functions/sddc/Get-CloudBuilderSDDCValidation.md +++ b/docs/documentation/functions/sddc/Get-CloudBuilderSDDCValidation.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Restart-CloudBuilderSDDC.md b/docs/documentation/functions/sddc/Restart-CloudBuilderSDDC.md index 31bbe19f3..aee4366c1 100644 --- a/docs/documentation/functions/sddc/Restart-CloudBuilderSDDC.md +++ b/docs/documentation/functions/sddc/Restart-CloudBuilderSDDC.md @@ -68,4 +68,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Restart-CloudBuilderSDDCValidation.md b/docs/documentation/functions/sddc/Restart-CloudBuilderSDDCValidation.md index fd1fe2075..8142f6fd0 100644 --- a/docs/documentation/functions/sddc/Restart-CloudBuilderSDDCValidation.md +++ b/docs/documentation/functions/sddc/Restart-CloudBuilderSDDCValidation.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Start-CloudBuilderSDDC.md b/docs/documentation/functions/sddc/Start-CloudBuilderSDDC.md index 298aae792..461f2bcd2 100644 --- a/docs/documentation/functions/sddc/Start-CloudBuilderSDDC.md +++ b/docs/documentation/functions/sddc/Start-CloudBuilderSDDC.md @@ -56,4 +56,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Start-CloudBuilderSDDCValidation.md b/docs/documentation/functions/sddc/Start-CloudBuilderSDDCValidation.md index a5cc58cb2..17bac60d7 100644 --- a/docs/documentation/functions/sddc/Start-CloudBuilderSDDCValidation.md +++ b/docs/documentation/functions/sddc/Start-CloudBuilderSDDCValidation.md @@ -68,4 +68,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sddc/Stop-CloudBuilderSDDCValidation.md b/docs/documentation/functions/sddc/Stop-CloudBuilderSDDCValidation.md index 766d5d89b..34c580eec 100644 --- a/docs/documentation/functions/sddc/Stop-CloudBuilderSDDCValidation.md +++ b/docs/documentation/functions/sddc/Stop-CloudBuilderSDDCValidation.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/services/Get-VCFService.md b/docs/documentation/functions/services/Get-VCFService.md index ec5ad6f6d..4c3db3db4 100644 --- a/docs/documentation/functions/services/Get-VCFService.md +++ b/docs/documentation/functions/services/Get-VCFService.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sos/Get-VCFHealthSummaryTask.md b/docs/documentation/functions/sos/Get-VCFHealthSummaryTask.md index d7adec3c9..c4af95e96 100644 --- a/docs/documentation/functions/sos/Get-VCFHealthSummaryTask.md +++ b/docs/documentation/functions/sos/Get-VCFHealthSummaryTask.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sos/Get-VCFSupportBundleTask.md b/docs/documentation/functions/sos/Get-VCFSupportBundleTask.md index 979a3f13d..61cae0be7 100644 --- a/docs/documentation/functions/sos/Get-VCFSupportBundleTask.md +++ b/docs/documentation/functions/sos/Get-VCFSupportBundleTask.md @@ -51,4 +51,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sos/Invoke-VCFCommand.md b/docs/documentation/functions/sos/Invoke-VCFCommand.md deleted file mode 100644 index ada995040..000000000 --- a/docs/documentation/functions/sos/Invoke-VCFCommand.md +++ /dev/null @@ -1,91 +0,0 @@ -# Invoke-VCFCommand - -## Synopsis - -Connects to the specified SDDC Manager using SSH and invoke SSH commands (SoS). - -## Syntax - -```powershell -Invoke-VCFCommand [[-vcfPassword] ] [[-rootPassword] ] [-sosOption] [] -``` - -## Description - -The `Invoke-VCFCommand` cmdlet connects to the specified SDDC Manager over SSH using the `vcf` user and subsequently run elevated SOS commands using the `root` account. - -???+ note "Note" - - The `Invoke-VCFCommand` cmdlet requires the `POSH-SSH` module to be installed. - -## Examples - -### Example 1 - -```powershell -Invoke-VCFCommand -vcfpassword VMware1! -rootPassword VMware1! -sosOption general-health -``` - -This example will run and display the output of "/opt/vmware/sddc-support/sos --general-health". - -### Example 2 - -```powershell -Invoke-VCFCommand -sosOption general-health -``` - -This example will ask for vcf and root password to the user and then run and display the output of "/opt/vmware/sddc-support/sos --general-health". - -## Parameters - -### -vcfPassword - -{{ Fill vcfPassword Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -rootPassword - -{{ Fill rootPassword Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -sosOption - -{{ Fill sosOption Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### Common Parameters - -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). diff --git a/docs/documentation/functions/sos/Request-VCFHealthSummaryBundle.md b/docs/documentation/functions/sos/Request-VCFHealthSummaryBundle.md index 99f497b25..99bfc1dff 100644 --- a/docs/documentation/functions/sos/Request-VCFHealthSummaryBundle.md +++ b/docs/documentation/functions/sos/Request-VCFHealthSummaryBundle.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sos/Request-VCFSupportBundle.md b/docs/documentation/functions/sos/Request-VCFSupportBundle.md index 5880adf5e..9b0af0a96 100644 --- a/docs/documentation/functions/sos/Request-VCFSupportBundle.md +++ b/docs/documentation/functions/sos/Request-VCFSupportBundle.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sos/Start-VCFHealthSummary.md b/docs/documentation/functions/sos/Start-VCFHealthSummary.md index bc0499c93..3cedeeb4a 100644 --- a/docs/documentation/functions/sos/Start-VCFHealthSummary.md +++ b/docs/documentation/functions/sos/Start-VCFHealthSummary.md @@ -50,4 +50,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/sos/Start-VCFSupportBundle.md b/docs/documentation/functions/sos/Start-VCFSupportBundle.md index 38db07c9c..efd501ee3 100644 --- a/docs/documentation/functions/sos/Start-VCFSupportBundle.md +++ b/docs/documentation/functions/sos/Start-VCFSupportBundle.md @@ -49,4 +49,4 @@ Accept wildcard characters: False ``` ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/system-prechecks/Get-VCFSystemPrecheckTask.md b/docs/documentation/functions/system-prechecks/Get-VCFSystemPrecheckTask.md index aacdacc73..c3570e1fe 100644 --- a/docs/documentation/functions/system-prechecks/Get-VCFSystemPrecheckTask.md +++ b/docs/documentation/functions/system-prechecks/Get-VCFSystemPrecheckTask.md @@ -24,6 +24,14 @@ Get-VCFSystemPrecheckTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d This example shows how to retrieve the status of a system level precheck task by unique ID. +### Example 2 + +```powershell +Get-VCFSystemPrecheckTask -id 4d661acc-2be6-491d-9256-ba3c78020e5d -failureOnly +``` + +This example shows how to retrieve only failed subtasks from the system level precheck task by unique ID. + ## Parameters ### -id @@ -41,7 +49,21 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -failureOnly + +Specifies to return only the failed subtasks. + +```yaml +Type: Switch +Parameter Sets: (All) +Aliases: +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/system-prechecks/Start-VCFSystemPrecheck.md b/docs/documentation/functions/system-prechecks/Start-VCFSystemPrecheck.md index 6cee42b46..6fc45b7f9 100644 --- a/docs/documentation/functions/system-prechecks/Start-VCFSystemPrecheck.md +++ b/docs/documentation/functions/system-prechecks/Start-VCFSystemPrecheck.md @@ -50,4 +50,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/tasks/Get-VCFTask.md b/docs/documentation/functions/tasks/Get-VCFTask.md index 3225113f0..25c0a5787 100644 --- a/docs/documentation/functions/tasks/Get-VCFTask.md +++ b/docs/documentation/functions/tasks/Get-VCFTask.md @@ -76,4 +76,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/tasks/Restart-VCFTask.md b/docs/documentation/functions/tasks/Restart-VCFTask.md index 689801bea..e24bf25e4 100644 --- a/docs/documentation/functions/tasks/Restart-VCFTask.md +++ b/docs/documentation/functions/tasks/Restart-VCFTask.md @@ -44,4 +44,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/upgrades/Get-VCFUpgrade.md b/docs/documentation/functions/upgrades/Get-VCFUpgrade.md index 5b0c3b0a0..55efaf37c 100644 --- a/docs/documentation/functions/upgrades/Get-VCFUpgrade.md +++ b/docs/documentation/functions/upgrades/Get-VCFUpgrade.md @@ -52,4 +52,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/upgrades/Start-VCFUpgrade.md b/docs/documentation/functions/upgrades/Start-VCFUpgrade.md index bd28cbdd5..08f6aed87 100644 --- a/docs/documentation/functions/upgrades/Start-VCFUpgrade.md +++ b/docs/documentation/functions/upgrades/Start-VCFUpgrade.md @@ -51,4 +51,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/documentation/functions/vcenters/Get-VCFvCenter.md b/docs/documentation/functions/vcenters/Get-VCFvCenter.md index 5235022d5..28067601f 100644 --- a/docs/documentation/functions/vcenters/Get-VCFvCenter.md +++ b/docs/documentation/functions/vcenters/Get-VCFvCenter.md @@ -84,4 +84,4 @@ Accept wildcard characters: False ### Common Parameters -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). +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). diff --git a/docs/index.md b/docs/index.md index da155e6d5..2b868a620 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,26 +14,22 @@ ## Requirements -### Platforms +### VMware Cloud Foundation -The following table lists the supported platforms for this module. +The following table lists the supported releases for this module. -Platform | Supported --------------------------------------------------------------|------------------------------------ -:fontawesome-solid-cloud:   VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 5.0 | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 4.3 | :fontawesome-solid-check:{ .green } +| Platform | Support | +|--------------------------------------------------------------| ----------------------------------- | +| :fontawesome-solid-cloud:   VMware Cloud Foundation 5.2 | :fontawesome-solid-check:{ .green } | +| :fontawesome-solid-cloud:   VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green } | -### Operating Systems +???+ tip "Support for Newer Major Releases" -The following table lists the supported operating systems for this module. + This module will **only** be sustained for supported versions of the VMware Cloud Foundation releases listed above to address critical issues. You can find general details on supported versions in the [Broadcom Product Lifecycle](https://support.broadcom.com/group/ecx/productlifecycle). -Operating System | Version ------------------------------------------------------------------------|----------- -:fontawesome-brands-windows:   Microsoft Windows Server | 2019, 2022 -:fontawesome-brands-windows:   Microsoft Windows | 10, 11 + Please note that this module **will not** provide support or new enhancements for future major releases of VMware Cloud Foundation. If you're planning to upgrade to those newer releases, we encourage you to explore alternative in-product or custom automation solutions. + + We truly appreciate your reliance on and support of this module. Thank you for your understanding as we transition to sustaining the module for these specific major versions. ### PowerShell diff --git a/docs/requirements.txt b/docs/requirements.txt index e1502187f..a3fb468c2 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,4 @@ -mkdocs-git-authors-plugin>=0.7.2 -mkdocs-git-revision-date-localized-plugin>=1.2.0 +mkdocs-git-revision-date-localized-plugin>=1.2.2 mkdocs-markdownextradata-plugin>=0.2.5 -mkdocs-minify-plugin>=0.7.1 -mkdocs-open-in-new-tab>=1.0.2 +mkdocs-minify-plugin>=0.7.2 +mkdocs-open-in-new-tab>=1.0.3 diff --git a/mkdocs.yml b/mkdocs.yml index 9ddb62807..64eef57a5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,7 @@ edit_uri: blob/main/docs/ # Copyright copyright: | - Copyright © 2023 Broadcom. All Rights Reserved.
+ Copyright © 2005-2024 Broadcom. All Rights Reserved.
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

# Configuration @@ -23,7 +23,7 @@ theme: logo: assets/images/icon-white.svg icon: repo: fontawesome/brands/github - palette: + palette: - media: "(prefers-color-scheme: light)" scheme: default primary: indigo @@ -69,7 +69,6 @@ plugins: jinja_options: variable_start_string: "${{" variable_end_string: "}}" -- git-authors - git-revision-date-localized: enabled: !ENV [CI, false] enable_creation_date: false @@ -89,8 +88,6 @@ extra: social: - icon: fontawesome/brands/github link: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation - - icon: fontawesome/brands/twitter - link: https://twitter.com/powervcf - icon: fontawesome/solid/book link: https://docs.vmware.com/en/VMware-Cloud-Foundation/index.html - icon: fontawesome/solid/code @@ -105,8 +102,8 @@ markdown_extensions: - footnotes - md_in_html - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg options: custom_icons: - material/.icons @@ -129,7 +126,7 @@ markdown_extensions: # Navigation nav: -- Getting Started: +- Getting Started: - index.md - Installation: documentation/getting-started/install.md - Updating: documentation/getting-started/update.md @@ -140,7 +137,7 @@ nav: - License: license.md - Reference: - documentation/index.md - - Application Virtual Networks: + - Application Virtual Networks: - documentation/functions/avns/Add-VCFApplicationVirtualNetwork.md - documentation/functions/avns/Get-VCFApplicationVirtualNetwork.md - Authentication: @@ -182,6 +179,13 @@ nav: - documentation/functions/clusters/New-VCFCluster.md - documentation/functions/clusters/Remove-VCFCluster.md - documentation/functions/clusters/Set-VCFCluster.md + - Compliance: + - documentation/functions/compliance/Get-VCFCompliance.md + - documentation/functions/compliance/Get-VCFComplianceConfiguration.md + - documentation/functions/compliance/Get-VCFComplianceHistory.md + - documentation/functions/compliance/Get-VCFComplianceStandard.md + - documentation/functions/compliance/Get-VCFComplianceTask.md + - documentation/functions/compliance/New-VCFCompliance.md - Credentials: - documentation/functions/credentials/Get-VCFCredential.md - documentation/functions/credentials/Get-VCFCredentialExpiry.md @@ -226,6 +230,8 @@ nav: - documentation/functions/idp/New-VCFIdentityProvider.md - documentation/functions/idp/Remove-VCFIdentityProvider.md - documentation/functions/idp/Update-VCFIdentityProvider.md + - JSON Export: + - documentation/functions/json-export/Export-VCFManagementDomainJsonSpec.md - Licenses: - documentation/functions/licenses/Get-VCFLicenseKey.md - documentation/functions/licenses/Get-VCFLicenseMode.md @@ -281,7 +287,6 @@ nav: - documentation/functions/sos/Get-VCFHealthSummaryTask.md - documentation/functions/sos/Request-VCFHealthSummaryBundle.md - documentation/functions/sos/Start-VCFHealthSummary.md - - documentation/functions/sos/Invoke-VCFCommand.md - Support Bundles: - documentation/functions/sos/Get-VCFSupportBundleTask.md - documentation/functions/sos/Request-VCFSupportBundle.md @@ -315,6 +320,8 @@ nav: - documentation/functions/aria-suite/aria-operations-logs/Set-VCFVrliConnection.md - Workspace ONE Access: - documentation/functions/aria-suite/workspace-one-access/Get-VCFWsa.md + - Other: + - documentation/functions/other/Invoke-VCFCommand.md - Community: - community/index.md - Contributing: community/contributing.md diff --git a/samples/hosts/ui-commissionHostsSpec.json b/samples/hosts/ui-commissionHostsSpec.json new file mode 100644 index 000000000..ab5f04b5e --- /dev/null +++ b/samples/hosts/ui-commissionHostsSpec.json @@ -0,0 +1,32 @@ + { + "hostsSpec": [ + { + "hostfqdn": "sfo01-w01-esx01.sfo.rainpole.io", + "username": "root", + "storageType": "VSAN", + "password": "VMw@re1!", + "networkPoolName": "sfo-w01-np01" + }, + { + "hostfqdn": "sfo01-w01-esx02.sfo.rainpole.io", + "username": "root", + "storageType": "VSAN", + "password": "VMw@re1!", + "networkPoolName": "sfo-w01-np01" + }, + { + "hostfqdn": "sfo01-w01-esx03.sfo.rainpole.io", + "username": "root", + "storageType": "VSAN", + "password": "VMw@re1!", + "networkPoolName": "sfo-w01-np01" + }, + { + "hostfqdn": "sfo01-w01-esx04.sfo.rainpole.io", + "username": "root", + "storageType": "VSAN", + "password": "VMw@re1!", + "networkPoolName": "sfo-w01-np01" + } + ] +} \ No newline at end of file