├── .ci
└── pester.tests.ps1
├── .github
├── ISSUE_TEMPLATE
│ ├── bug.yml
│ ├── config.yml
│ ├── docs.yml
│ └── enhancement.yml
├── dependabot.yml
├── icon-400px.png
├── icon-400px.svg
├── icon-85px.svg
├── labeler-issues.yml
├── labeler-pull-requests.yml
├── pull_request_template.md
└── workflows
│ ├── docs.yml
│ ├── issues.yml
│ ├── lock-threads.yml
│ ├── pull-requests.yml
│ ├── release.yml
│ ├── stale.yml
│ └── tests.yml
├── .gitignore
├── .vscode
├── extensions.json
└── settings.json
├── CHANGELOG.md
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── NOTICE
├── PowerValidatedSolutions.psd1
├── PowerValidatedSolutions.psm1
├── README.md
├── SampleNotifications
├── aria-operations-logs-alerts-datacenter-vcf.json
├── aria-operations-logs-alerts-iom.json
├── aria-operations-logs-alerts-vcf.json
├── aria-operations-logs-alerts-vm-asl.json
├── aria-operations-notifications-srm.json
└── aria-operations-notifications-vcf.json
├── SampleYaml
├── sfo-w01-tkc01-cluster.yaml
└── tanzuClusterTemplate.yaml
├── config.PowerValidatedSolutions
├── docs
├── assets
│ ├── images
│ │ ├── icon-color.svg
│ │ └── icon-white.svg
│ └── stylesheets
│ │ └── extra.css
├── community
│ ├── code-of-conduct.md
│ ├── contributing.md
│ ├── index.md
│ └── support.md
├── documentation
│ ├── functions
│ │ ├── active-directory
│ │ │ ├── Get-ADPrincipalGuid.md
│ │ │ └── Test-ADAuthentication.md
│ │ ├── aria-suite
│ │ │ ├── aria-automation-orchestrator
│ │ │ │ ├── Add-CEPTrustedCertificate.md
│ │ │ │ ├── Add-CEPvCenterServer.md
│ │ │ │ ├── Add-vROTrustedCertificate.md
│ │ │ │ ├── Add-vROvCenterServer.md
│ │ │ │ ├── Get-CEPWorkflow.md
│ │ │ │ ├── Get-CEPWorkflowExecution.md
│ │ │ │ ├── Get-CEPWorkflowExecutionState.md
│ │ │ │ ├── Get-vROVersion.md
│ │ │ │ ├── Get-vROWorkflow.md
│ │ │ │ ├── Get-vROWorkflowExecution.md
│ │ │ │ ├── Get-vROWorkflowExecutionResult.md
│ │ │ │ ├── Get-vROWorkflowExecutionState.md
│ │ │ │ ├── Invoke-CEPWorkflow.md
│ │ │ │ ├── Invoke-vRORestMethod.md
│ │ │ │ ├── Invoke-vROWorkflow.md
│ │ │ │ ├── New-vROParameterDefinition.md
│ │ │ │ └── Remove-vROvCenterServer.md
│ │ │ ├── aria-automation
│ │ │ │ ├── Add-vRACloudAccount.md
│ │ │ │ ├── Add-vRAGroup.md
│ │ │ │ ├── Add-vRAIntegrationItem.md
│ │ │ │ ├── Add-vRANotification.md
│ │ │ │ ├── Add-vRAResourceComputeTag.md
│ │ │ │ ├── Add-vRAUser.md
│ │ │ │ ├── Export-vRAJsonSpec.md
│ │ │ │ ├── Get-CloudProxy.md
│ │ │ │ ├── Get-CloudProxyOtk.md
│ │ │ │ ├── Get-vRAAPIVersion.md
│ │ │ │ ├── Get-vRACloudAccount.md
│ │ │ │ ├── Get-vRACloudZone.md
│ │ │ │ ├── Get-vRAGroup.md
│ │ │ │ ├── Get-vRAGroupRoles.md
│ │ │ │ ├── Get-vRAIntegrationDetail.md
│ │ │ │ ├── Get-vRANotification.md
│ │ │ │ ├── Get-vRAOrganizationDisplayName.md
│ │ │ │ ├── Get-vRAOrganizationId.md
│ │ │ │ ├── Get-vRAResourceCompute.md
│ │ │ │ ├── Get-vRAServerDetail.md
│ │ │ │ ├── Get-vRAServices.md
│ │ │ │ ├── Get-vRAUser.md
│ │ │ │ ├── Get-vRAUserRoles.md
│ │ │ │ ├── Get-vRAvRLIConfig.md
│ │ │ │ ├── New-vRACloudAccount.md
│ │ │ │ ├── New-vRADeployment.md
│ │ │ │ ├── New-vRAGroup.md
│ │ │ │ ├── New-vRANotification.md
│ │ │ │ ├── New-vRAUser.md
│ │ │ │ ├── New-vRAvROPSIntegrationItem.md
│ │ │ │ ├── Remove-vRACloudAccount.md
│ │ │ │ ├── Remove-vRACloudZone.md
│ │ │ │ ├── Remove-vRAGroupOrgRole.md
│ │ │ │ ├── Remove-vRAGroupRoles.md
│ │ │ │ ├── Remove-vRAGroupServiceRole.md
│ │ │ │ ├── Remove-vRAIntegrationItem.md
│ │ │ │ ├── Remove-vRANotification.md
│ │ │ │ ├── Remove-vRAUserOrgRole.md
│ │ │ │ ├── Remove-vRAUserServiceRole.md
│ │ │ │ ├── Remove-vRAvRLIConfig.md
│ │ │ │ ├── Request-vRAToken.md
│ │ │ │ ├── Set-vRADnsConfig.md
│ │ │ │ ├── Set-vRAGroupOrgRole.md
│ │ │ │ ├── Set-vRAGroupServiceRole.md
│ │ │ │ ├── Set-vRANtpConfig.md
│ │ │ │ ├── Set-vRAOrganizationDisplayName.md
│ │ │ │ ├── Set-vRAUserOrgRole.md
│ │ │ │ ├── Set-vRAUserServiceRole.md
│ │ │ │ ├── Set-vRAvRLIConfig.md
│ │ │ │ ├── Test-vRAAuthentication.md
│ │ │ │ ├── Test-vRAConnection.md
│ │ │ │ ├── Test-vRAIntegrationItem.md
│ │ │ │ ├── Undo-vRACloudAccount.md
│ │ │ │ ├── Undo-vRADeployment.md
│ │ │ │ ├── Undo-vRADnsConfig.md
│ │ │ │ ├── Undo-vRAGroup.md
│ │ │ │ ├── Undo-vRANtpConfig.md
│ │ │ │ ├── Undo-vRAUser.md
│ │ │ │ ├── Undo-vRAvROPsIntegrationItem.md
│ │ │ │ ├── Update-vRACloudAccountZone.md
│ │ │ │ ├── Update-vRACloudZone.md
│ │ │ │ └── Update-vRAOrganizationDisplayName.md
│ │ │ ├── aria-operations-logs
│ │ │ │ ├── Add-vRLIAgentGroup.md
│ │ │ │ ├── Add-vRLIAlertDatacenter.md
│ │ │ │ ├── Add-vRLIAlertVirtualMachine.md
│ │ │ │ ├── Add-vRLIAuthenticationAD.md
│ │ │ │ ├── Add-vRLIAuthenticationGroup.md
│ │ │ │ ├── Add-vRLIAuthenticationWSA.md
│ │ │ │ ├── Add-vRLIGroup.md
│ │ │ │ ├── Add-vRLILogArchive.md
│ │ │ │ ├── Add-vRLILogForwarder.md
│ │ │ │ ├── Add-vRLISmtpConfiguration.md
│ │ │ │ ├── Disable-vRLIAlert.md
│ │ │ │ ├── Enable-vRLIAlert.md
│ │ │ │ ├── Enable-vRLIContentPack.md
│ │ │ │ ├── Export-vRLIJsonSpec.md
│ │ │ │ ├── Get-vRLIAgentGroup.md
│ │ │ │ ├── Get-vRLIAlert.md
│ │ │ │ ├── Get-vRLIAuthenticationAD.md
│ │ │ │ ├── Get-vRLIAuthenticationWSA.md
│ │ │ │ ├── Get-vRLIContentPack.md
│ │ │ │ ├── Get-vRLIEmailNotification.md
│ │ │ │ ├── Get-vRLIGroup.md
│ │ │ │ ├── Get-vRLIIndexPartition.md
│ │ │ │ ├── Get-vRLILogForwarder.md
│ │ │ │ ├── Get-vRLIMarketplaceMetadata.md
│ │ │ │ ├── Get-vRLIRetentionThreshold.md
│ │ │ │ ├── Get-vRLIRole.md
│ │ │ │ ├── Get-vRLIServerDetail.md
│ │ │ │ ├── Get-vRLISmtpConfiguration.md
│ │ │ │ ├── Get-vRLIVersion.md
│ │ │ │ ├── Install-vRLIContentPack.md
│ │ │ │ ├── Install-vRLIPhotonAgent.md
│ │ │ │ ├── New-vRLIAgentGroup.md
│ │ │ │ ├── New-vRLIAlert.md
│ │ │ │ ├── New-vRLIDeployment.md
│ │ │ │ ├── Register-vRLIWorkloadDomain.md
│ │ │ │ ├── Remove-vRLIAgentGroup.md
│ │ │ │ ├── Remove-vRLIAlert.md
│ │ │ │ ├── Remove-vRLIAuthenticationAD.md
│ │ │ │ ├── Remove-vRLIAuthenticationWSA.md
│ │ │ │ ├── Remove-vRLIGroup.md
│ │ │ │ ├── Remove-vRLILogForwarder.md
│ │ │ │ ├── Request-vRLIToken.md
│ │ │ │ ├── Set-vRLIAlert.md
│ │ │ │ ├── Set-vRLIAuthenticationAD.md
│ │ │ │ ├── Set-vRLIAuthenticationWSA.md
│ │ │ │ ├── Set-vRLIEmailNotification.md
│ │ │ │ ├── Set-vRLILogArchive.md
│ │ │ │ ├── Set-vRLILogForwarder.md
│ │ │ │ ├── Set-vRLIRetentionThreshold.md
│ │ │ │ ├── Set-vRLISmtpConfiguration.md
│ │ │ │ ├── Set-vRLISyslogEdgeCluster.md
│ │ │ │ ├── Test-vRLIAuthentication.md
│ │ │ │ ├── Test-vRLIConnection.md
│ │ │ │ ├── Test-vRLILogForwarder.md
│ │ │ │ ├── Undo-vRLIAgentGroup.md
│ │ │ │ ├── Undo-vRLIAlert.md
│ │ │ │ ├── Undo-vRLIAuthenticationAD.md
│ │ │ │ ├── Undo-vRLIAuthenticationGroup.md
│ │ │ │ ├── Undo-vRLIAuthenticationWSA.md
│ │ │ │ ├── Undo-vRLIDeployment.md
│ │ │ │ ├── Undo-vRLILogForwarder.md
│ │ │ │ ├── Undo-vRLIPhotonAgent.md
│ │ │ │ ├── Undo-vRLISyslogEdgeCluster.md
│ │ │ │ ├── Update-vRLIAlert.md
│ │ │ │ ├── Update-vRLIContentPack.md
│ │ │ │ └── Update-vRLILogForwarder.md
│ │ │ ├── aria-operations-networks
│ │ │ │ ├── Add-AriaNetworksLdapConfiguration.md
│ │ │ │ ├── Add-AriaNetworksNsxDataSource.md
│ │ │ │ ├── Add-AriaNetworksVcenterDataSource.md
│ │ │ │ ├── Export-AriaNetworksJsonSpec.md
│ │ │ │ ├── Get-AriaNetworksDataSource.md
│ │ │ │ ├── Get-AriaNetworksLdapConfiguration.md
│ │ │ │ ├── Get-AriaNetworksNodes.md
│ │ │ │ ├── New-AriaNetworksDeployment.md
│ │ │ │ ├── New-AriaNetworksLdapConfiguration.md
│ │ │ │ ├── New-AriaNetworksNsxtDataSource.md
│ │ │ │ ├── New-AriaNetworksvCenterDataSource.md
│ │ │ │ ├── Remove-AriaNetworksDataSource.md
│ │ │ │ ├── Remove-AriaNetworksLdapConfiguration.md
│ │ │ │ ├── Request-AriaNetworksInternalApi.md
│ │ │ │ ├── Request-AriaNetworksInternalApiToken.md
│ │ │ │ ├── Request-AriaNetworksToken.md
│ │ │ │ ├── Test-AriaNetworksAuthentication.md
│ │ │ │ ├── Test-AriaNetworksConnection.md
│ │ │ │ ├── Test-AriaNetworksInternalAuthentication.md
│ │ │ │ ├── Undo-AriaNetworksDeployment.md
│ │ │ │ ├── Undo-AriaNetworksLdapConfiguration.md
│ │ │ │ ├── Undo-AriaNetworksNsxDataSource.md
│ │ │ │ ├── Undo-AriaNetworksVcenterDataSource.md
│ │ │ │ ├── Update-AriaNetworksNsxtDataSourceCredentials.md
│ │ │ │ └── Update-AriaNetworksvCenterDataSourceCredentials.md
│ │ │ ├── aria-operations
│ │ │ │ ├── Add-vROPSAdapter.md
│ │ │ │ ├── Add-vROPSAdapterIdentityManager.md
│ │ │ │ ├── Add-vROPSAdapterNsxt.md
│ │ │ │ ├── Add-vROPSAdapterPing.md
│ │ │ │ ├── Add-vROPSAdapterSddcHealth.md
│ │ │ │ ├── Add-vROPSAdapterSrm.md
│ │ │ │ ├── Add-vROPSAdapterVcf.md
│ │ │ │ ├── Add-vROPSAdapterVr.md
│ │ │ │ ├── Add-vROPSAlertPlugin.md
│ │ │ │ ├── Add-vROPSAlertPluginEmail.md
│ │ │ │ ├── Add-vROPSCollectorGroup.md
│ │ │ │ ├── Add-vROPSCredential.md
│ │ │ │ ├── Add-vROPSCurrency.md
│ │ │ │ ├── Add-vROPSGroupRemoteCollectors.md
│ │ │ │ ├── Add-vROPSNsxCredential.md
│ │ │ │ ├── Add-vROPSNtpServer.md
│ │ │ │ ├── Add-vROPSUserAccount.md
│ │ │ │ ├── Add-vROPSUserGroup.md
│ │ │ │ ├── Add-vROPSVcenterCredential.md
│ │ │ │ ├── Add-vROPSVcfCredential.md
│ │ │ │ ├── Enable-vROPSManagementPack.md
│ │ │ │ ├── Export-vROPsJsonSpec.md
│ │ │ │ ├── Get-vROPSAdapter.md
│ │ │ │ ├── Get-vROPSAdapterKind.md
│ │ │ │ ├── Get-vROPSAlertDefinition.md
│ │ │ │ ├── Get-vROPSAlertPlugin.md
│ │ │ │ ├── Get-vROPSAuthRole.md
│ │ │ │ ├── Get-vROPSAuthSource.md
│ │ │ │ ├── Get-vROPSCollector.md
│ │ │ │ ├── Get-vROPSCollectorGroup.md
│ │ │ │ ├── Get-vROPSCredential.md
│ │ │ │ ├── Get-vROPSCurrency.md
│ │ │ │ ├── Get-vROPSManagementPack.md
│ │ │ │ ├── Get-vROPSManagementPackActivity.md
│ │ │ │ ├── Get-vROPSManagementPackStatus.md
│ │ │ │ ├── Get-vROPSNotification.md
│ │ │ │ ├── Get-vROPSResourceDetail.md
│ │ │ │ ├── Get-vROPSSolution.md
│ │ │ │ ├── Get-vROPSUserAccount.md
│ │ │ │ ├── Get-vROPSUserGroup.md
│ │ │ │ ├── Get-vROPSVersion.md
│ │ │ │ ├── Get-vROPsServerDetail.md
│ │ │ │ ├── Get-vROpsLogForwarding.md
│ │ │ │ ├── Import-vROPSManagementPack.md
│ │ │ │ ├── Import-vROPSNotification.md
│ │ │ │ ├── Import-vROPSUserAccount.md
│ │ │ │ ├── Import-vROPSUserGroup.md
│ │ │ │ ├── Install-vROPSManagementPack.md
│ │ │ │ ├── New-vROPSDeployment.md
│ │ │ │ ├── New-vROPSNotification.md
│ │ │ │ ├── Register-vROPSManagementPack.md
│ │ │ │ ├── Register-vROPSWorkloadDomain.md
│ │ │ │ ├── Remove-OperationsDefaultAdapter.md
│ │ │ │ ├── Remove-vROPSAdapter.md
│ │ │ │ ├── Remove-vROPSAlertPlugin.md
│ │ │ │ ├── Remove-vROPSCollectorGroup.md
│ │ │ │ ├── Remove-vROPSCredential.md
│ │ │ │ ├── Remove-vROPSNotification.md
│ │ │ │ ├── Remove-vROPSUserAccount.md
│ │ │ │ ├── Remove-vROPSUserGroup.md
│ │ │ │ ├── Request-vROPSToken.md
│ │ │ │ ├── Request-vROpsLogForwardingConfig.md
│ │ │ │ ├── Search-vROPSUserAccount.md
│ │ │ │ ├── Search-vROPSUserGroup.md
│ │ │ │ ├── Set-vROPSAdapter.md
│ │ │ │ ├── Set-vROPSAlertPlugin.md
│ │ │ │ ├── Set-vROPSAlertPluginStatus.md
│ │ │ │ ├── Set-vROPSCurrency.md
│ │ │ │ ├── Set-vROPSDnsConfig.md
│ │ │ │ ├── Set-vROPSManagementPack.md
│ │ │ │ ├── Start-vROPSAdapter.md
│ │ │ │ ├── Stop-vROPSAdapter.md
│ │ │ │ ├── Test-vROPSAdapterConnection.md
│ │ │ │ ├── Test-vROPSAuthentication.md
│ │ │ │ ├── Test-vROPSConnection.md
│ │ │ │ ├── Test-vROPsAdapterStatus.md
│ │ │ │ ├── Test-vROPsAdapterStatusByType.md
│ │ │ │ ├── Undo-vROPSAdapter.md
│ │ │ │ ├── Undo-vROPSCredential.md
│ │ │ │ ├── Undo-vROPSDeployment.md
│ │ │ │ ├── Undo-vROPSDnsConfig.md
│ │ │ │ ├── Undo-vROPSNtpServer.md
│ │ │ │ ├── Update-vROPSAdapterCollecterGroup.md
│ │ │ │ ├── Update-vROPSAdapterSddcHealth.md
│ │ │ │ ├── Update-vROPSAdapterVcenter.md
│ │ │ │ ├── Update-vROPSUserAccount.md
│ │ │ │ └── Update-vROPSvRAAdapterCredential.md
│ │ │ └── aria-suite-lifecycle
│ │ │ │ ├── Add-vRSLCMApplianceNtpConfig.md
│ │ │ │ ├── Add-vRSLCMDatacenter.md
│ │ │ │ ├── Add-vRSLCMDatacenterVcenter.md
│ │ │ │ ├── Add-vRSLCMEnvironment.md
│ │ │ │ ├── Add-vRSLCMGroup.md
│ │ │ │ ├── Add-vRSLCMGroupRole.md
│ │ │ │ ├── Add-vRSLCMLockerCertificate.md
│ │ │ │ ├── Add-vRSLCMLockerLicense.md
│ │ │ │ ├── Add-vRSLCMLockerPassword.md
│ │ │ │ ├── Add-vRSLCMMyVMwareAccount.md
│ │ │ │ ├── Add-vRSLCMNtpServer.md
│ │ │ │ ├── Add-vRSLCMProductNtpServer.md
│ │ │ │ ├── Connect-vRSLCMUpgradeIso.md
│ │ │ │ ├── Disconnect-vRSLCMUpgradeIso.md
│ │ │ │ ├── Get-vRSLCMApplianceNtpConfig.md
│ │ │ │ ├── Get-vRSLCMDatacenter.md
│ │ │ │ ├── Get-vRSLCMDatacenterVcenter.md
│ │ │ │ ├── Get-vRSLCMEnvironment.md
│ │ │ │ ├── Get-vRSLCMEnvironmentVMs.md
│ │ │ │ ├── Get-vRSLCMGroup.md
│ │ │ │ ├── Get-vRSLCMHealth.md
│ │ │ │ ├── Get-vRSLCMLoadbalancer.md
│ │ │ │ ├── Get-vRSLCMLockerCertificate.md
│ │ │ │ ├── Get-vRSLCMLockerLicense.md
│ │ │ │ ├── Get-vRSLCMLockerPassword.md
│ │ │ │ ├── Get-vRSLCMMyVmwareAccount.md
│ │ │ │ ├── Get-vRSLCMPSPack.md
│ │ │ │ ├── Get-vRSLCMProductBinaries.md
│ │ │ │ ├── Get-vRSLCMProductBinariesMapped.md
│ │ │ │ ├── Get-vRSLCMProductDetails.md
│ │ │ │ ├── Get-vRSLCMProductNode.md
│ │ │ │ ├── Get-vRSLCMProductNtpServer.md
│ │ │ │ ├── Get-vRSLCMProductPassword.md
│ │ │ │ ├── Get-vRSLCMProductVersion.md
│ │ │ │ ├── Get-vRSLCMRequest.md
│ │ │ │ ├── Get-vRSLCMRole.md
│ │ │ │ ├── Get-vRSLCMServerDetail.md
│ │ │ │ ├── Get-vRSLCMSshStatus.md
│ │ │ │ ├── Import-vRSLCMLockerCertificate.md
│ │ │ │ ├── Import-vRSLCMPSPack.md
│ │ │ │ ├── Install-vRSLCMCertificate.md
│ │ │ │ ├── Install-vRSLCMPSPack.md
│ │ │ │ ├── Invoke-vRSLCMUpgrade.md
│ │ │ │ ├── New-vRSLCMAdapterOperation.md
│ │ │ │ ├── New-vRSLCMDatacenter.md
│ │ │ │ ├── New-vRSLCMDatacenterVcenter.md
│ │ │ │ ├── New-vRSLCMDeployment.md
│ │ │ │ ├── New-vRSLCMLoadbalancer.md
│ │ │ │ ├── New-vRSLCMLockerLicense.md
│ │ │ │ ├── New-vRSLCMLockerPassword.md
│ │ │ │ ├── New-vRSLCMMyVmwareAccount.md
│ │ │ │ ├── Register-vRSLCMProductBinary.md
│ │ │ │ ├── Remove-vRSLCMDatacenter.md
│ │ │ │ ├── Remove-vRSLCMEnvironment.md
│ │ │ │ ├── Remove-vRSLCMGroup.md
│ │ │ │ ├── Remove-vRSLCMLoadbalancer.md
│ │ │ │ ├── Remove-vRSLCMLockerCertificate.md
│ │ │ │ ├── Remove-vRSLCMLockerLicense.md
│ │ │ │ ├── Remove-vRSLCMLockerPassword.md
│ │ │ │ ├── Remove-vRSLCMMyVmwareAccount.md
│ │ │ │ ├── Remove-vRSLCMProductNtpServer.md
│ │ │ │ ├── Remove-vRSLCMRequest.md
│ │ │ │ ├── Request-vRSLCMBundle.md
│ │ │ │ ├── Request-vRSLCMProductBinary.md
│ │ │ │ ├── Request-vRSLCMToken.md
│ │ │ │ ├── Resume-vRSLCMRequest.md
│ │ │ │ ├── Set-vRSLCMApplianceNtpConfig.md
│ │ │ │ ├── Set-vRSLCMDnsConfig.md
│ │ │ │ ├── Start-vRSLCMProductNode.md
│ │ │ │ ├── Start-vRSLCMUpgrade.md
│ │ │ │ ├── Stop-vRSLCMProductNode.md
│ │ │ │ ├── Sync-vRSLCMDatacenterVcenter.md
│ │ │ │ ├── Test-vRSLCMAuthentication.md
│ │ │ │ ├── Test-vRSLCMConnection.md
│ │ │ │ ├── Undo-vRSLCMDatacenter.md
│ │ │ │ ├── Undo-vRSLCMDeployment.md
│ │ │ │ ├── Undo-vRSLCMDnsConfig.md
│ │ │ │ ├── Undo-vRSLCMGroupRole.md
│ │ │ │ ├── Undo-vRSLCMLoadBalancer.md
│ │ │ │ ├── Undo-vRSLCMLockerCertificate.md
│ │ │ │ ├── Undo-vRSLCMLockerLicense.md
│ │ │ │ ├── Undo-vRSLCMLockerPassword.md
│ │ │ │ ├── Undo-vRSLCMMyVMwareAccount.md
│ │ │ │ ├── Undo-vRSLCMNtpServer.md
│ │ │ │ ├── Update-vRSLCMPSPack.md
│ │ │ │ └── Watch-vRSLCMRequest.md
│ │ ├── certificates
│ │ │ ├── Get-MscaRootCertificate.md
│ │ │ ├── Invoke-GenerateChainPem.md
│ │ │ ├── Invoke-GeneratePKCS12.md
│ │ │ ├── Invoke-GeneratePrivateKeyAndCsr.md
│ │ │ ├── Invoke-RequestSignedCertificate.md
│ │ │ └── Request-SignedCertificate.md
│ │ ├── nsx
│ │ │ ├── Add-CertToNsxCertificateStore.md
│ │ │ ├── Add-NetworkSegment.md
│ │ │ ├── Add-NsxtGlobalManagerCertificate.md
│ │ │ ├── Add-NsxtGlobalManagerClusterNode.md
│ │ │ ├── Add-NsxtGlobalManagerLocation.md
│ │ │ ├── Add-NsxtGlobalManagerMode.md
│ │ │ ├── Add-NsxtGlobalManagerTier1Gateway.md
│ │ │ ├── Add-NsxtGlobalManagerVirtualIp.md
│ │ │ ├── Add-NsxtIdentitySource.md
│ │ │ ├── Add-NsxtLdapRole.md
│ │ │ ├── Add-NsxtNodeProfileSyslogExporter.md
│ │ │ ├── Add-NsxtPrefix.md
│ │ │ ├── Add-NsxtPrincipalIdentity.md
│ │ │ ├── Add-NsxtRemoteTunnelEndpoint.md
│ │ │ ├── Add-NsxtVidmRole.md
│ │ │ ├── Add-PrefixList.md
│ │ │ ├── Add-RouteMap.md
│ │ │ ├── Copy-vRealizeLoadBalancer.md
│ │ │ ├── Deploy-NsxtGlobalManager.md
│ │ │ ├── Export-NsxtGlobalManagerTier0GatewayConfig.md
│ │ │ ├── Get-NSXLBDetails.md
│ │ │ ├── Get-NsxEdgeCluster.md
│ │ │ ├── Get-NsxtAlarm.md
│ │ │ ├── Get-NsxtApplianceUser.md
│ │ │ ├── Get-NsxtBackupConfiguration.md
│ │ │ ├── Get-NsxtBackupHistory.md
│ │ │ ├── Get-NsxtCertificate.md
│ │ │ ├── Get-NsxtComputeManager.md
│ │ │ ├── Get-NsxtComputeManagerStatus.md
│ │ │ ├── Get-NsxtEdgeCluster.md
│ │ │ ├── Get-NsxtEdgeNode.md
│ │ │ ├── Get-NsxtEdgeNodeAuthPolicy.md
│ │ │ ├── Get-NsxtEvent.md
│ │ │ ├── Get-NsxtGlobalManager.md
│ │ │ ├── Get-NsxtGlobalManagerBackupOverview.md
│ │ │ ├── Get-NsxtGlobalManagerCertificate.md
│ │ │ ├── Get-NsxtGlobalManagerCertificateResult.md
│ │ │ ├── Get-NsxtGlobalManagerCluster.md
│ │ │ ├── Get-NsxtGlobalManagerClusterStatus.md
│ │ │ ├── Get-NsxtGlobalManagerClusterVirtualIp.md
│ │ │ ├── Get-NsxtGlobalManagerConfig.md
│ │ │ ├── Get-NsxtGlobalManagerEdgeCluster.md
│ │ │ ├── Get-NsxtGlobalManagerLocation.md
│ │ │ ├── Get-NsxtGlobalManagerOnBoarding.md
│ │ │ ├── Get-NsxtGlobalManagerOperationalState.md
│ │ │ ├── Get-NsxtGlobalManagerSegment.md
│ │ │ ├── Get-NsxtGlobalManagerTier0BgpNeighborConfig.md
│ │ │ ├── Get-NsxtGlobalManagerTier0Gateway.md
│ │ │ ├── Get-NsxtGlobalManagerTier0LocaleServices.md
│ │ │ ├── Get-NsxtGlobalManagerTier0ServiceInterface.md
│ │ │ ├── Get-NsxtGlobalManagerTier1Gateway.md
│ │ │ ├── Get-NsxtGlobalManagerTier1LocaleServices.md
│ │ │ ├── Get-NsxtGlobalSegmentID.md
│ │ │ ├── Get-NsxtGroup.md
│ │ │ ├── Get-NsxtIpPool.md
│ │ │ ├── Get-NsxtIpPoolSubnet.md
│ │ │ ├── Get-NsxtLdap.md
│ │ │ ├── Get-NsxtLocaleService.md
│ │ │ ├── Get-NsxtLogicalRouter.md
│ │ │ ├── Get-NsxtManagerAuthPolicy.md
│ │ │ ├── Get-NsxtNodeProfile.md
│ │ │ ├── Get-NsxtPrefixList.md
│ │ │ ├── Get-NsxtPrincipalIdentity.md
│ │ │ ├── Get-NsxtRole.md
│ │ │ ├── Get-NsxtRouteMap.md
│ │ │ ├── Get-NsxtRouteRedistributionPolicy.md
│ │ │ ├── Get-NsxtRoutingConfigRedistribution.md
│ │ │ ├── Get-NsxtRoutingConfigRedistributionRule.md
│ │ │ ├── Get-NsxtRoutingConfigRouteMap.md
│ │ │ ├── Get-NsxtSecurityPolicy.md
│ │ │ ├── Get-NsxtSegment.md
│ │ │ ├── Get-NsxtServerDetail.md
│ │ │ ├── Get-NsxtSyslogExporter.md
│ │ │ ├── Get-NsxtSyslogStatus.md
│ │ │ ├── Get-NsxtTier0BgpStatus.md
│ │ │ ├── Get-NsxtTier0Gateway.md
│ │ │ ├── Get-NsxtTier0LocaleServiceBgp.md
│ │ │ ├── Get-NsxtTier1Gateway.md
│ │ │ ├── Get-NsxtTransportNode.md
│ │ │ ├── Get-NsxtTransportNodeStatus.md
│ │ │ ├── Get-NsxtTransportNodeTunnel.md
│ │ │ ├── Get-NsxtTransportNodeTunnelStatus.md
│ │ │ ├── Get-NsxtTransportZone.md
│ │ │ ├── Get-NsxtUser.md
│ │ │ ├── Get-NsxtVidm.md
│ │ │ ├── Get-NsxtVidmGroup.md
│ │ │ ├── Get-NsxtVidmStatus.md
│ │ │ ├── Get-NsxtVidmUser.md
│ │ │ ├── Import-NsxtGlobalManagerCertificate.md
│ │ │ ├── Import-NsxtGlobalManagerLocation.md
│ │ │ ├── Install-NsxtGlobalManagerCertificate.md
│ │ │ ├── Join-NsxtGlobalManagerCluster.md
│ │ │ ├── New-NsxtGlobalManagerLocation.md
│ │ │ ├── New-NsxtGlobalManagerTier0BgpNeighborConfig.md
│ │ │ ├── New-NsxtGlobalManagerTier0LocaleServices.md
│ │ │ ├── New-NsxtGlobalManagerTier0ServiceInterface.md
│ │ │ ├── New-NsxtGlobalManagerTier1Gateway.md
│ │ │ ├── New-NsxtGlobalManagerTier1LocaleServices.md
│ │ │ ├── New-NsxtIpPool.md
│ │ │ ├── New-NsxtIpPoolSubnet.md
│ │ │ ├── New-NsxtLBAppProfile.md
│ │ │ ├── New-NsxtLBPersistenceAppProfile.md
│ │ │ ├── New-NsxtLBPool.md
│ │ │ ├── New-NsxtLBServiceMonitor.md
│ │ │ ├── New-NsxtLBVirtualServer.md
│ │ │ ├── New-NsxtLdap.md
│ │ │ ├── New-NsxtLoadBalancer.md
│ │ │ ├── New-NsxtPrefixList.md
│ │ │ ├── New-NsxtPrincipalIdentity.md
│ │ │ ├── New-NsxtRouteMap.md
│ │ │ ├── New-NsxtSegment.md
│ │ │ ├── New-NsxtTier0BgpNeighborConfig.md
│ │ │ ├── New-NsxtTier1.md
│ │ │ ├── New-NsxtTier1ServiceInterface.md
│ │ │ ├── New-NsxtTier1StaticRoute.md
│ │ │ ├── New-vRealizeLoadBalancerSpec.md
│ │ │ ├── Remove-NsxtGlobalManager.md
│ │ │ ├── Remove-NsxtGlobalManagerClusterNode.md
│ │ │ ├── Remove-NsxtGlobalManagerClusterVirtualIp.md
│ │ │ ├── Remove-NsxtGlobalManagerLocation.md
│ │ │ ├── Remove-NsxtGlobalManagerStandby.md
│ │ │ ├── Remove-NsxtGlobalManagerTier0BgpNeighborConfig.md
│ │ │ ├── Remove-NsxtGlobalManagerTier0Gateway.md
│ │ │ ├── Remove-NsxtGlobalManagerTier0LocaleServices.md
│ │ │ ├── Remove-NsxtGlobalManagerTier0ServiceInterface.md
│ │ │ ├── Remove-NsxtGlobalManagerTier1Gateway.md
│ │ │ ├── Remove-NsxtGlobalManagerTier1LocaleServices.md
│ │ │ ├── Remove-NsxtGroup.md
│ │ │ ├── Remove-NsxtIpPool.md
│ │ │ ├── Remove-NsxtIpPoolSubnet.md
│ │ │ ├── Remove-NsxtLdap.md
│ │ │ ├── Remove-NsxtNodeProfileSyslogExporter.md
│ │ │ ├── Remove-NsxtPrefixList.md
│ │ │ ├── Remove-NsxtPrincipalIdentity.md
│ │ │ ├── Remove-NsxtRole.md
│ │ │ ├── Remove-NsxtRouteMap.md
│ │ │ ├── Remove-NsxtSecurityPolicy.md
│ │ │ ├── Remove-NsxtSegment.md
│ │ │ ├── Remove-NsxtSyslogExporter.md
│ │ │ ├── Request-NsxtToken.md
│ │ │ ├── Set-NsxtApplianceUserExpirationPolicy.md
│ │ │ ├── Set-NsxtApplianceUserPassword.md
│ │ │ ├── Set-NsxtCertificate.md
│ │ │ ├── Set-NsxtComputeManager.md
│ │ │ ├── Set-NsxtEdgeNodeAuthPolicy.md
│ │ │ ├── Set-NsxtGlobalManagerClusterVirtualIp.md
│ │ │ ├── Set-NsxtGlobalManagerSegment.md
│ │ │ ├── Set-NsxtGloblaManagerActive.md
│ │ │ ├── Set-NsxtGloblaManagerStandby.md
│ │ │ ├── Set-NsxtManagerAuthPolicy.md
│ │ │ ├── Set-NsxtMtuRemoteTunnelEndpoint.md
│ │ │ ├── Set-NsxtNodeProfileSyslogExporter.md
│ │ │ ├── Set-NsxtRole.md
│ │ │ ├── Set-NsxtRouteRedistributionPolicy.md
│ │ │ ├── Set-NsxtRoutingConfigRedistributionRule.md
│ │ │ ├── Set-NsxtSyslogExporter.md
│ │ │ ├── Set-NsxtTier1.md
│ │ │ ├── Set-NsxtTransportNode.md
│ │ │ ├── Set-NsxtVidm.md
│ │ │ ├── Start-NsxtBackup.md
│ │ │ ├── Start-NsxtGlobalManagerOnBoarding.md
│ │ │ ├── Test-NsxtAuthentication.md
│ │ │ ├── Test-NsxtConnection.md
│ │ │ ├── Test-NsxtGlobalManagerCertificate.md
│ │ │ ├── Test-NsxtVersionCompatibility.md
│ │ │ ├── Undo-NetworkSegment.md
│ │ │ ├── Undo-NsxtGlobalManagerStandby.md
│ │ │ ├── Undo-NsxtGlobalManagerTier0Gateway.md
│ │ │ ├── Undo-NsxtGlobalManagerTier1Gateway.md
│ │ │ ├── Undo-NsxtGlobalManagerVirtualIp.md
│ │ │ ├── Undo-NsxtIdentitySource.md
│ │ │ ├── Undo-NsxtLdapRole.md
│ │ │ ├── Undo-NsxtNodeProfileSyslogExporter.md
│ │ │ ├── Undo-NsxtPrincipalIdentity.md
│ │ │ ├── Undo-NsxtRemoteTunnelEndpoint.md
│ │ │ ├── Undo-NsxtVidmRole.md
│ │ │ ├── Undo-PrefixList.md
│ │ │ ├── Undo-RouteMap.md
│ │ │ ├── Update-NsxtGlobalManagerSegment.md
│ │ │ ├── Update-NsxtGlobalManagerTier0Gateway.md
│ │ │ ├── Update-NsxtGlobalManagerTier0LocaleService.md
│ │ │ ├── Update-NsxtGlobalManagerTier1Gateway.md
│ │ │ └── Update-NsxtGlobalManagerTier1LocaleService.md
│ │ ├── sddc-manager
│ │ │ ├── Add-SddcManagerRole.md
│ │ │ ├── Get-VCFDnsSearchDomain.md
│ │ │ ├── Test-VCFAuthentication.md
│ │ │ ├── Test-VCFConnection.md
│ │ │ ├── Undo-SddcManagerRole.md
│ │ │ └── Update-SddcDeployedFlavor.md
│ │ ├── site-recovery-manager
│ │ │ ├── Add-ProtectionGroup.md
│ │ │ ├── Add-RecoveryPlan.md
│ │ │ ├── Add-SrmLicenseKey.md
│ │ │ ├── Add-SrmMapping.md
│ │ │ ├── Add-SrmProtectionGroup.md
│ │ │ ├── Add-SrmRecoveryPlan.md
│ │ │ ├── Add-SrmRecoveryPlanCalloutStep.md
│ │ │ ├── Connect-SrmRemoteSession.md
│ │ │ ├── Get-SrmApplianceDetail.md
│ │ │ ├── Get-SrmConfiguration.md
│ │ │ ├── Get-SrmNetworkAll.md
│ │ │ ├── Get-SrmNetworkDns.md
│ │ │ ├── Get-SrmNetworkInterface.md
│ │ │ ├── Get-SrmProtectionGroup.md
│ │ │ ├── Get-SrmRecoveryPlan.md
│ │ │ ├── Get-SrmRecoveryPlanStep.md
│ │ │ ├── Get-SrmRecoveryPlanVm.md
│ │ │ ├── Get-SrmService.md
│ │ │ ├── Get-SrmSitePairing.md
│ │ │ ├── Get-SrmTask.md
│ │ │ ├── Get-SrmVamiCertificate.md
│ │ │ ├── Install-SiteRecoveryManager.md
│ │ │ ├── Install-VamiCertificate.md
│ │ │ ├── New-SrmSitePair.md
│ │ │ ├── Remove-SrmConfiguration.md
│ │ │ ├── Remove-SrmProtectionGroup.md
│ │ │ ├── Remove-SrmRecoveryPlan.md
│ │ │ ├── Request-SrmToken.md
│ │ │ ├── Request-SrmTokenREST.md
│ │ │ ├── Request-VamiPKCS12Certificate.md
│ │ │ ├── Set-RecoveryPlan.md
│ │ │ ├── Set-SrmApplianceState.md
│ │ │ ├── Set-SrmConfiguration.md
│ │ │ ├── Set-SrmNetworkDns.md
│ │ │ ├── Set-SrmNetworkInterface.md
│ │ │ ├── Set-SrmRecoveryPlanVMPriority.md
│ │ │ ├── Set-SrmService.md
│ │ │ ├── Set-SrmVamiCertificate.md
│ │ │ ├── Test-SrmAuthentication.md
│ │ │ ├── Test-SrmAuthenticationREST.md
│ │ │ ├── Test-SrmConnection.md
│ │ │ ├── Test-SrmSdkAuthentication.md
│ │ │ ├── Test-SrmVamiAuthentication.md
│ │ │ ├── Test-SrmVamiConnection.md
│ │ │ ├── Undo-ProtectionGroup.md
│ │ │ ├── Undo-RecoveryPlan.md
│ │ │ ├── Undo-SiteRecoveryManager.md
│ │ │ ├── Undo-SrmLicenseKey.md
│ │ │ ├── Undo-SrmMapping.md
│ │ │ └── Undo-SrmSitePair.md
│ │ ├── solutions
│ │ │ ├── cbr
│ │ │ │ ├── Export-CbrJsonSpec.md
│ │ │ │ ├── Invoke-CbrDeployment.md
│ │ │ │ ├── Invoke-CbrSolutionInterop.md
│ │ │ │ ├── Invoke-UndoCbrDeployment.md
│ │ │ │ ├── Invoke-UndoCbrSolutionInterop.md
│ │ │ │ ├── Test-CbrPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── cbw
│ │ │ │ ├── Export-CbwJsonSpec.md
│ │ │ │ ├── Invoke-CbwDeployment.md
│ │ │ │ ├── Invoke-CbwSolutionInterop.md
│ │ │ │ ├── Invoke-UndoCbwDeployment.md
│ │ │ │ ├── Invoke-UndoCbwSolutionInterop.md
│ │ │ │ ├── Test-CbwPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── ccm
│ │ │ │ ├── Export-CcmJsonSpec.md
│ │ │ │ ├── Invoke-CcmDeployment.md
│ │ │ │ ├── Invoke-CcmSolutionInterop.md
│ │ │ │ ├── Invoke-UndoCcmDeployment.md
│ │ │ │ ├── Invoke-UndoCcmSolutionInterop.md
│ │ │ │ ├── Test-CcmPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── dri
│ │ │ │ ├── Export-DriJsonSpec.md
│ │ │ │ ├── Invoke-DriDeployment.md
│ │ │ │ ├── Invoke-UndoDriDeployment.md
│ │ │ │ ├── Test-DriPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── fed
│ │ │ │ ├── Export-NsxFederationJsonSpec.md
│ │ │ │ ├── Invoke-NsxFederationDeployment.md
│ │ │ │ ├── Request-NsxFederationMscaSignedCertificate.md
│ │ │ │ ├── Test-NsxFederationPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── hrm
│ │ │ │ ├── Deploy-PhotonAppliance.md
│ │ │ │ ├── Export-HrmJsonSpec.md
│ │ │ │ ├── Invoke-HrmDeployment.md
│ │ │ │ ├── Invoke-UndoHrmDeployment.md
│ │ │ │ ├── Remove-PhotonAppliance.md
│ │ │ │ ├── Test-HrmPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── iam
│ │ │ │ ├── Export-IamJsonSpec.md
│ │ │ │ ├── Invoke-IamDeployment.md
│ │ │ │ ├── Invoke-UndoIamDeployment.md
│ │ │ │ ├── Request-IamMscaSignedCertificate.md
│ │ │ │ ├── Test-IamPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── ila
│ │ │ │ ├── Export-IlaJsonSpec.md
│ │ │ │ ├── Invoke-IlaDeployment.md
│ │ │ │ ├── Invoke-IlaSolutionInterop.md
│ │ │ │ ├── Invoke-UndoIlaDeployment.md
│ │ │ │ ├── Invoke-UndoIlaSolutionInterop.md
│ │ │ │ ├── Request-IlaMscaSignedCertificate.md
│ │ │ │ ├── Test-IlaPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── inv
│ │ │ │ ├── Export-InvJsonSpec.md
│ │ │ │ ├── Invoke-InvDeployment.md
│ │ │ │ ├── Invoke-InvSolutionInterop.md
│ │ │ │ ├── Invoke-UndoInvDeployment.md
│ │ │ │ ├── Invoke-UndoInvSolutionInterop.md
│ │ │ │ ├── Request-InvMscaSignedCertificate.md
│ │ │ │ ├── Test-InvPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── iom
│ │ │ │ ├── Export-IomJsonSpec.md
│ │ │ │ ├── Invoke-IomDeployment.md
│ │ │ │ ├── Invoke-IomSolutionInterop.md
│ │ │ │ ├── Invoke-UndoIomDeployment.md
│ │ │ │ ├── Invoke-UndoIomSolutionInterop.md
│ │ │ │ ├── Request-IomMscaSignedCertificate.md
│ │ │ │ ├── Test-IomPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── lcm
│ │ │ │ ├── Export-VrslcmJsonSpec.md
│ │ │ │ ├── Invoke-VrslcmDeployment.md
│ │ │ │ ├── Invoke-VrslcmUndoDeployment.md
│ │ │ │ ├── Test-VrslcmPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── pca
│ │ │ │ ├── Export-PcaJsonSpec.md
│ │ │ │ ├── Invoke-PcaDeployment.md
│ │ │ │ ├── Invoke-PcaSolutionInterop.md
│ │ │ │ ├── Invoke-UndoPcaDeployment.md
│ │ │ │ ├── Invoke-UndoPcaSolutionInterop.md
│ │ │ │ ├── Request-PcaMscaSignedCertificate.md
│ │ │ │ ├── Test-PcaPrerequisite.md
│ │ │ │ └── index.md
│ │ │ ├── pdr
│ │ │ │ ├── Export-PdrJsonSpec.md
│ │ │ │ ├── Invoke-PdrDeployment.md
│ │ │ │ ├── Invoke-PdrSolutionInterop.md
│ │ │ │ ├── Invoke-UndoPdrDeployment.md
│ │ │ │ ├── Invoke-UndoPdrSolutionInterop.md
│ │ │ │ ├── Test-PdrPrerequisite.md
│ │ │ │ └── index.md
│ │ │ └── wsa
│ │ │ │ ├── Export-GlobalWsaJsonSpec.md
│ │ │ │ ├── Invoke-GlobalWsaDeployment.md
│ │ │ │ ├── Invoke-UndoGlobalWsaDeployment.md
│ │ │ │ ├── Request-WSAMscaSignedCertificate.md
│ │ │ │ ├── Test-GlobalWsaPrerequisite.md
│ │ │ │ └── index.md
│ │ ├── supporting
│ │ │ ├── Show-PowerValidatedSolutionsOutput.md
│ │ │ ├── Test-DnsServers.md
│ │ │ ├── Test-EndpointConnection.md
│ │ │ ├── Test-IPaddressArray.md
│ │ │ ├── Test-IpAddress.md
│ │ │ ├── Test-NtpServer.md
│ │ │ ├── Test-PowerValidatedSolutionsPrereq.md
│ │ │ └── Test-PrereqDnsEntries.md
│ │ ├── vsphere-replication
│ │ │ ├── Add-EsxiVrmsStaticRoute.md
│ │ │ ├── Add-EsxiVrmsVMkernelPort.md
│ │ │ ├── Add-VrmsNetworkAdapter.md
│ │ │ ├── Add-VrmsReplication.md
│ │ │ ├── Add-vSphereReplication.md
│ │ │ ├── Connect-DRSolutionTovCenter.md
│ │ │ ├── Connect-VrmsRemoteSession.md
│ │ │ ├── Get-VrmsApplianceDetail.md
│ │ │ ├── Get-VrmsConfiguration.md
│ │ │ ├── Get-VrmsDatastore.md
│ │ │ ├── Get-VrmsNetworkAll.md
│ │ │ ├── Get-VrmsNetworkDns.md
│ │ │ ├── Get-VrmsNetworkInterface.md
│ │ │ ├── Get-VrmsReplication.md
│ │ │ ├── Get-VrmsService.md
│ │ │ ├── Get-VrmsSitePairing.md
│ │ │ ├── Get-VrmsTask.md
│ │ │ ├── Get-VrmsVamiCertificate.md
│ │ │ ├── Get-VrmsVm.md
│ │ │ ├── Install-VamiCertificate.md
│ │ │ ├── Install-vSphereReplicationManager.md
│ │ │ ├── Remove-VrmsConfiguration.md
│ │ │ ├── Remove-VrmsReplication.md
│ │ │ ├── Request-VamiPKCS12Certificate.md
│ │ │ ├── Request-VrmsToken.md
│ │ │ ├── Request-VrmsTokenREST.md
│ │ │ ├── Set-VrmsApplianceState.md
│ │ │ ├── Set-VrmsConfiguration.md
│ │ │ ├── Set-VrmsNetworkDns.md
│ │ │ ├── Set-VrmsNetworkInterface.md
│ │ │ ├── Set-VrmsReplication.md
│ │ │ ├── Set-VrmsService.md
│ │ │ ├── Set-VrmsVamiCertificate.md
│ │ │ ├── Test-VrSdkAuthentication.md
│ │ │ ├── Test-VrmsAuthenticationREST.md
│ │ │ ├── Test-VrmsVamiAuthentication.md
│ │ │ ├── Test-VrmsVamiConnection.md
│ │ │ ├── Undo-DRSolutionTovCenter.md
│ │ │ ├── Undo-EsxiVrmsStaticRoute.md
│ │ │ ├── Undo-EsxiVrmsVMkernelPort.md
│ │ │ ├── Undo-vSphereReplication.md
│ │ │ └── Undo-vSphereReplicationManager.md
│ │ ├── vsphere-tanzu
│ │ │ ├── Add-Namespace.md
│ │ │ ├── Add-NamespacePermission.md
│ │ │ ├── Add-NamespaceVmClass.md
│ │ │ ├── Add-SupervisorClusterLicense.md
│ │ │ ├── Add-SupervisorService.md
│ │ │ ├── Add-TanzuKubernetesCluster.md
│ │ │ ├── Add-VMClass.md
│ │ │ ├── Connect-WMCluster.md
│ │ │ ├── Disconnect-WMCluster.md
│ │ │ ├── Enable-Registry.md
│ │ │ ├── Enable-SupervisorCluster.md
│ │ │ ├── Enable-WMRegistry.md
│ │ │ ├── Get-SubscribedLibrary.md
│ │ │ ├── Get-TanzuKubernetesCluster.md
│ │ │ ├── Get-VMClass.md
│ │ │ ├── Get-WMLicenseStatus.md
│ │ │ ├── Get-WMRegistry.md
│ │ │ ├── Get-WMRegistryHealth.md
│ │ │ ├── Install-SupervisorClusterCertificate.md
│ │ │ ├── Install-TanzuSignedCertificate.md
│ │ │ ├── New-SupervisorClusterCSR.md
│ │ │ ├── New-TanzuKubernetesCluster.md
│ │ │ ├── Remove-TanzuKubernetesCluster.md
│ │ │ ├── Remove-WMRegistry.md
│ │ │ ├── Request-WMClusterCSR.md
│ │ │ ├── Test-WMSubnetInput.md
│ │ │ ├── Undo-Namespace.md
│ │ │ ├── Undo-NamespacePermission.md
│ │ │ ├── Undo-Registry.md
│ │ │ ├── Undo-SupervisorCluster.md
│ │ │ ├── Undo-SupervisorService.md
│ │ │ ├── Undo-TanzuKubernetesCluster.md
│ │ │ └── Watch-WmClusterConfigStatus.md
│ │ ├── vsphere
│ │ │ ├── Add-AntiAffinityRule.md
│ │ │ ├── Add-ClusterGroup.md
│ │ │ ├── Add-ContentLibrary.md
│ │ │ ├── Add-DrsVmToVmGroup.md
│ │ │ ├── Add-GlobalPermission.md
│ │ │ ├── Add-IdentitySource.md
│ │ │ ├── Add-ResourcePool.md
│ │ │ ├── Add-SsoPermission.md
│ │ │ ├── Add-SsoUser.md
│ │ │ ├── Add-StorageFolder.md
│ │ │ ├── Add-StoragePolicy.md
│ │ │ ├── Add-VMFolder.md
│ │ │ ├── Add-VdsPortGroup.md
│ │ │ ├── Add-VmGroup.md
│ │ │ ├── Add-VmStartupRule.md
│ │ │ ├── Add-vCenterGlobalPermission.md
│ │ │ ├── Add-vSphereRole.md
│ │ │ ├── Backup-VMOvfProperties.md
│ │ │ ├── Connect-vSphereMobServer.md
│ │ │ ├── Copy-vSphereRole.md
│ │ │ ├── Disconnect-vSphereMobServer.md
│ │ │ ├── Get-DrsVmToVmGroup.md
│ │ │ ├── Get-ESXiAdminGroup.md
│ │ │ ├── Get-EsxiAlert.md
│ │ │ ├── Get-GlobalPermission.md
│ │ │ ├── Get-LocalAccountLockout.md
│ │ │ ├── Get-LocalPasswordComplexity.md
│ │ │ ├── Get-LocalUserPasswordExpiration.md
│ │ │ ├── Get-SnapshotConsolidation.md
│ │ │ ├── Get-SnapshotStatus.md
│ │ │ ├── Get-VCConfigurationDNS.md
│ │ │ ├── Get-VCConfigurationNTP.md
│ │ │ ├── Get-VCVersion.md
│ │ │ ├── Get-VCenterCEIP.md
│ │ │ ├── Get-VMOvfProperty.md
│ │ │ ├── Get-VMvAppConfig.md
│ │ │ ├── Get-VcLicense.md
│ │ │ ├── Get-VcenterBackupStatus.md
│ │ │ ├── Get-VcenterPasswordExpiration.md
│ │ │ ├── Get-VcenterRootPasswordExpiration.md
│ │ │ ├── Get-VcenterTriggeredAlarm.md
│ │ │ ├── Get-VsanHealthTest.md
│ │ │ ├── Get-vCenterServerDetail.md
│ │ │ ├── Import-ContentLibraryItem.md
│ │ │ ├── Install-VamiCertificate.md
│ │ │ ├── Invoke-VcenterCommand.md
│ │ │ ├── Move-VMtoFolder.md
│ │ │ ├── New-VMOvfProduct.md
│ │ │ ├── New-VMOvfProperty.md
│ │ │ ├── New-VcLicense.md
│ │ │ ├── Remove-DrsVmToVmGroup.md
│ │ │ ├── Remove-GlobalPermission.md
│ │ │ ├── Remove-VcLicense.md
│ │ │ ├── Request-VcenterApiToken.md
│ │ │ ├── Request-vSphereApiToken.md
│ │ │ ├── Restore-VMOvfProperties.md
│ │ │ ├── Set-DatastoreTag.md
│ │ │ ├── Set-ESXiAdminGroup.md
│ │ │ ├── Set-LocalAccountLockout.md
│ │ │ ├── Set-LocalPasswordComplexity.md
│ │ │ ├── Set-LocalUserPasswordExpiration.md
│ │ │ ├── Set-VCenterCEIP.md
│ │ │ ├── Set-VMOvfEULA.md
│ │ │ ├── Set-VMOvfEnvTransport.md
│ │ │ ├── Set-VMOvfIPAssignment.md
│ │ │ ├── Set-VMOvfProperty.md
│ │ │ ├── Set-VcenterPasswordExpiration.md
│ │ │ ├── Set-VcenterRootPasswordExpiration.md
│ │ │ ├── Set-vCenterPermission.md
│ │ │ ├── Test-EsxiAuthentication.md
│ │ │ ├── Test-EsxiConnection.md
│ │ │ ├── Test-SSOAuthentication.md
│ │ │ ├── Test-SSOConnection.md
│ │ │ ├── Test-VsphereAuthentication.md
│ │ │ ├── Test-VsphereConnection.md
│ │ │ ├── Test-vSphereApiAuthentication.md
│ │ │ ├── Test-vSphereApiConnection.md
│ │ │ ├── Undo-AntiAffinityRule.md
│ │ │ ├── Undo-ClusterGroup.md
│ │ │ ├── Undo-ContentLibrary.md
│ │ │ ├── Undo-DatastoreTag.md
│ │ │ ├── Undo-IdentitySource.md
│ │ │ ├── Undo-ResourcePool.md
│ │ │ ├── Undo-SsoPermission.md
│ │ │ ├── Undo-SsoUser.md
│ │ │ ├── Undo-StoragePolicy.md
│ │ │ ├── Undo-VMFolder.md
│ │ │ ├── Undo-VdsPortGroup.md
│ │ │ ├── Undo-VmStartupRule.md
│ │ │ ├── Undo-vCenterGlobalPermission.md
│ │ │ └── Undo-vSphereRole.md
│ │ └── workspace-one-access
│ │ │ ├── Add-WSAClient.md
│ │ │ ├── Add-WSAConnector.md
│ │ │ ├── Add-WSALdapDirectory.md
│ │ │ ├── Add-WSARoleAssociation.md
│ │ │ ├── Add-WorkspaceOneDirectory.md
│ │ │ ├── Add-WorkspaceOneDirectoryConnector.md
│ │ │ ├── Add-WorkspaceOneDirectoryGroup.md
│ │ │ ├── Add-WorkspaceOneRole.md
│ │ │ ├── Export-WsaJsonSpec.md
│ │ │ ├── Get-WSAActiveDirectoryGroupDetail.md
│ │ │ ├── Get-WSAClient.md
│ │ │ ├── Get-WSAConnector.md
│ │ │ ├── Get-WSADirectoryDomain.md
│ │ │ ├── Get-WSAGroup.md
│ │ │ ├── Get-WSAIdentityProvider.md
│ │ │ ├── Get-WSAOAuthToken.md
│ │ │ ├── Get-WSARole.md
│ │ │ ├── Get-WSARoleAssociation.md
│ │ │ ├── Get-WSARoleId.md
│ │ │ ├── Get-WSARuleSet.md
│ │ │ ├── Get-WSAServerDetail.md
│ │ │ ├── Get-WSASmtpConfiguration.md
│ │ │ ├── Get-WSAUser.md
│ │ │ ├── Get-WsaAccountLockout.md
│ │ │ ├── Get-WsaDirectory.md
│ │ │ ├── Get-WsaPasswordPolicy.md
│ │ │ ├── Initialize-WorkspaceOne.md
│ │ │ ├── Install-WorkspaceOne.md
│ │ │ ├── Install-WorkspaceOneCertificate.md
│ │ │ ├── Invoke-WsaDirectorySync.md
│ │ │ ├── New-WSADeployment.md
│ │ │ ├── Request-WSAToken.md
│ │ │ ├── Set-WSABindPassword.md
│ │ │ ├── Set-WSADirectoryGroup.md
│ │ │ ├── Set-WSADirectoryUser.md
│ │ │ ├── Set-WSARoleMember.md
│ │ │ ├── Set-WSASmtpConfiguration.md
│ │ │ ├── Set-WSASyncSetting.md
│ │ │ ├── Set-WorkspaceOneApplianceNtpConfig.md
│ │ │ ├── Set-WorkspaceOneDnsConfig.md
│ │ │ ├── Set-WorkspaceOneNsxtIntegration.md
│ │ │ ├── Set-WorkspaceOneNtpConfig.md
│ │ │ ├── Set-WorkspaceOneSmtpConfig.md
│ │ │ ├── Set-WsaAccountLockout.md
│ │ │ ├── Set-WsaPasswordPolicy.md
│ │ │ ├── Start-WSADirectorySync.md
│ │ │ ├── Test-WSAAuthentication.md
│ │ │ ├── Test-WSAConnection.md
│ │ │ ├── Undo-WSADeployment.md
│ │ │ ├── Undo-WorkspaceOne.md
│ │ │ ├── Undo-WorkspaceOneDirectoryGroup.md
│ │ │ ├── Undo-WorkspaceOneDnsConfig.md
│ │ │ └── Undo-WorkspaceOneNsxtIntegration.md
│ ├── index.md
│ └── user-guide
│ │ └── certificate-generation.md
├── favicon.ico
├── index.md
├── install.md
├── license.md
├── release-notes.md
├── requirements.txt
├── snippets
│ ├── copy-module-local-linux.sh
│ ├── copy-module-local-windows.ps1
│ ├── import-module-local-linux.ps1
│ ├── import-module.ps1
│ ├── install-module.ps1
│ ├── installed-module.ps1
│ ├── pre-req-linux.sh
│ ├── save-module-local-linux.ps1
│ ├── save-module-local-windows.ps1
│ ├── update-module.ps1
│ └── update-modules.ps1
├── update.md
└── user-access.md
├── mkdocs.yml
└── vSphereRoles
├── aria-automation-assembler-vsphere-integration.role
├── aria-operations-for-logs-vsphere-integration.role
├── aria-operations-for-networks-vsphere-integration.role
├── aria-operations-vsphere-integration-actions.role
├── aria-operations-vsphere-integration-metrics.role
├── aria-operations-vsphere-integration.role
├── aria-suite-lifecycle-vsphere-integration.role
├── nsx-vsphere-integration.role
└── vlcr-vsphere-integration.role
/.ci/pester.tests.ps1:
--------------------------------------------------------------------------------
1 | Describe -Tag:('ModuleValidation') 'Module Basic Tests' {
2 |
3 | It 'is present' {
4 | $module = Get-Module -Name $moduleName
5 | $module | Should -Be $true
6 | }
7 |
8 | It ('passes Test-ModuleManifest') {
9 | Test-ModuleManifest -Path $moduleManifest | Should -Not -BeNullOrEmpty
10 | $? | Should -Be $true
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | blank_issues_enabled: false
2 | contact_links:
3 | - name: Module Documentation
4 | url: 'https://vmware.github.io/power-validated-solutions-for-cloud-foundation/'
5 | about: Having trouble with the module? Check out the documentation.
6 | - name: VMware Validated Solutions
7 | url: https://vmware.com/go/vvs
8 | about: VMware Validated Solutions are technical validated implementations built and tested by VMware and VMware Partners, designed to help customers solve common business problems using VMware Cloud Foundation as the foundational infrastructure.
9 | - name: VMware Cloud Foundation Product Documentation
10 | url: https://docs.vmware.com/en/VMware-Cloud-Foundation/
11 | about: Efficiently manage virtual machine and container workloads. Deliver cloud benefits to on-premises, full-stack hyperconverged infrastructure deployments.
12 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | ---
2 | version: 2
3 | updates:
4 | - package-ecosystem: "github-actions"
5 | directory: "/"
6 | schedule:
7 | interval: "daily"
8 |
--------------------------------------------------------------------------------
/.github/icon-400px.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/.github/icon-400px.png
--------------------------------------------------------------------------------
/.github/icon-400px.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/labeler-issues.yml:
--------------------------------------------------------------------------------
1 | ---
2 | pending-review:
3 | - '.*'
4 |
--------------------------------------------------------------------------------
/.github/labeler-pull-requests.yml:
--------------------------------------------------------------------------------
1 | ---
2 | chore:
3 | - changed-files:
4 | - any-glob-to-any-file:
5 | - ".ci/**/*"
6 | - ".github/**/*"
7 | - ".gitignore"
8 | documentation:
9 | - changed-files:
10 | - any-glob-to-any-file:
11 | - "**/*.md"
12 | - "Makefile"
13 | - "**/*.md"
14 | - "mkdocs.yml"
15 | github-actions:
16 | - changed-files:
17 | - any-glob-to-any-file:
18 | - ".github/workflows/**/*"
19 | needs-review:
20 | - changed-files:
21 | - any-glob-to-any-file:
22 | - "**"
23 | samples:
24 | - changed-files:
25 | - any-glob-to-any-file:
26 | - "SampleNotifications/**/*"
27 | - "SampleScripts/**/*"
28 | - "SampleYaml/**/*"
29 |
--------------------------------------------------------------------------------
/.github/workflows/docs.yml:
--------------------------------------------------------------------------------
1 | name: Publish Documentation
2 | on:
3 | workflow_dispatch:
4 | permissions:
5 | contents: write
6 | jobs:
7 | publish-docs:
8 | runs-on: ubuntu-latest
9 | steps:
10 | - name: Checkout Repository
11 | uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
12 | with:
13 | fetch-depth: 0
14 | - name: Setup Python
15 | uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
16 | with:
17 | python-version: 3.x
18 | - name: Install Dependencies
19 | run: |
20 | pip install mkdocs-material
21 | pip install --requirement docs/requirements.txt
22 | - name: Publish Documentation
23 | run: |
24 | mkdocs gh-deploy --force
25 | if: ${{ success() }}
26 |
--------------------------------------------------------------------------------
/.github/workflows/issues.yml:
--------------------------------------------------------------------------------
1 | ---
2 | name: Issue Triage
3 |
4 | on:
5 | issues:
6 | types:
7 | - opened
8 |
9 | jobs:
10 | label-issues:
11 | runs-on: ubuntu-latest
12 | steps:
13 | - name: Apply Issue Triage Labels
14 | uses: github/issue-labeler@c1b0f9f52a63158c4adc09425e858e87b32e9685 # v3.4
15 | with:
16 | repo-token: '${{ secrets.GITHUB_TOKEN }}'
17 | configuration-path: .github/labeler-issues.yml
18 | enable-versioned-regex: 0
19 | include-title: 1
20 |
--------------------------------------------------------------------------------
/.github/workflows/lock-threads.yml:
--------------------------------------------------------------------------------
1 | ---
2 | name: Lock Threads
3 |
4 | on:
5 | schedule:
6 | - cron: 30 00 * * *
7 |
8 | jobs:
9 | lock:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - uses: dessant/lock-threads@d42e5f49803f3c4e14ffee0378e31481265dda22 # v5.0.0
13 | with:
14 | github-token: '${{ secrets.GITHUB_TOKEN }}'
15 | issue-comment: >
16 | I'm going to lock this issue because it has been closed for 30
17 | days. This helps our maintainers find and focus on the active
18 | issues.
19 |
20 |
21 | If you have found a problem that seems similar to this,
22 | please open a new issue and complete the issue template so we can
23 | capture all the details necessary to investigate further.
24 | issue-inactive-days: '30'
25 | pr-comment: >
26 | I'm going to lock this pull request because it has been closed for
27 | 30 days. This helps our maintainers find and focus on the active
28 | issues.
29 |
30 |
31 | If you have found a problem that seems related to this
32 | change, please open a new issue and complete the issue template so
33 | we can capture all the details necessary to investigate further.
34 | pr-inactive-days: '30'
35 |
--------------------------------------------------------------------------------
/.github/workflows/pull-requests.yml:
--------------------------------------------------------------------------------
1 | ---
2 | name: Pull Request Labels
3 |
4 | on:
5 | pull_request_target:
6 | branches:
7 | - develop
8 | types:
9 | - opened
10 | - synchronize
11 | - reopened
12 | - edited
13 | - ready_for_review
14 |
15 | jobs:
16 | labeler:
17 | name: Labeler
18 | runs-on: ubuntu-latest
19 | permissions:
20 | contents: read
21 | pull-requests: write
22 | steps:
23 | - name: Apply Labels
24 | uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
25 | with:
26 | configuration-path: .github/labeler-pull-requests.yml
27 | repo-token: '${{ secrets.GITHUB_TOKEN }}'
28 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # MacOS
2 | ## Ignore desktop services files.
3 | **/.DS_Store
4 |
5 | # MkDocs
6 | ## Ignore .site directory.
7 | **/.site/**
8 |
9 | # Trunk
10 | ## Ignore the .trunk directory.
11 | **/.trunk/**
12 |
--------------------------------------------------------------------------------
/.vscode/extensions.json:
--------------------------------------------------------------------------------
1 | {
2 | "recommendations": [
3 | "vscode.json-language-features", // JSON
4 | "davidanson.vscode-markdownlint", // Markdown Lint
5 | "eamodio.gitlens", // GitLens
6 | "esbenp.prettier-vscode", // Prettier
7 | "ms-vscode.powershell", // PowerShell
8 | "trunk.io" // Trunk
9 | ]
10 | }
11 |
--------------------------------------------------------------------------------
/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @vmware/power-validated-solutions-for-cloud-foundation-maintainers
2 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | BSD 2-Clause License
2 |
3 | Copyright 2023-2025 Broadcom. All Rights Reserved.
4 |
5 | Redistribution and use in source and binary forms, with or without
6 | modification, are permitted provided that the following conditions are
7 | met:
8 |
9 | 1. Redistributions of source code must retain the above copyright
10 | notice, this list of conditions and the following disclaimer.
11 |
12 | 2. Redistributions in binary form must reproduce the above
13 | copyright notice, this list of conditions and the following
14 | disclaimer in the documentation and/or other materials provided
15 | with the distribution.
16 |
17 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 | HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # Copyright 2023-2025 Broadcom. All Rights Reserved.
2 | # SPDX-License-Identifier: BSD-2
3 |
4 | docs-install:
5 | pip install mkdocs-material
6 | pip install --requirement docs/requirements.txt
7 |
8 | docs-serve:
9 | mkdocs serve
10 |
11 | docs-serve-live:
12 | mkdocs serve --livereload -w ./
13 |
14 | docs-build:
15 | mkdocs build
16 |
17 | docs-uninstall:
18 | pip uninstall mkdocs-material mkdocs -y
19 | pip uninstall --requirement docs/requirements.txt -y
20 |
--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 | PowerShell Module for VMware Validated Solutions
2 | Copyright 2023-2025 Broadcom. All Rights Reserved.
3 |
4 | This product is licensed to you under the BSD-2 license (the "License"). You may not use this product except in
5 | compliance with the BSD-2 License.
6 |
7 | This product may include a number of subcomponents with separate copyright notices and license terms. Your use of
8 | these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE
9 | file.
10 |
--------------------------------------------------------------------------------
/SampleNotifications/aria-operations-logs-alerts-iom.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "name": "vRops: VC stats query timed out occurred"
4 | },
5 | {
6 | "name": "vRops: Out of Memory errors occurred"
7 | },
8 | {
9 | "name": "ESXi: Licenses expiring soon"
10 | }
11 | ]
--------------------------------------------------------------------------------
/SampleYaml/sfo-w01-tkc01-cluster.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: run.tanzu.vmware.com/v1alpha1
2 | kind: TanzuKubernetesCluster
3 | metadata:
4 | name: sfo-w01-tkc01
5 | namespace: sfo-w01-tkc01
6 | spec:
7 | topology:
8 | controlPlane:
9 | count: 3
10 | class: guaranteed-small
11 | storageClass: vsphere-with-tanzu-storage-policy
12 | workers:
13 | count: 3
14 | class: guaranteed-small
15 | storageClass: vsphere-with-tanzu-storage-policy
16 | distribution:
17 | version: v1.24
18 | settings:
19 | network:
20 | cni:
21 | name: antrea
22 | services:
23 | cidrBlocks: ["198.51.100.0/12"]
24 | pods:
25 | cidrBlocks: ["192.0.2.0/16"]
--------------------------------------------------------------------------------
/SampleYaml/tanzuClusterTemplate.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: run.tanzu.vmware.com/v1alpha1
2 | kind: TanzuKubernetesCluster
3 | metadata:
4 | name:
5 | namespace:
6 | spec:
7 | topology:
8 | controlPlane:
9 | count: 3
10 | class:
11 | storageClass:
12 | workers:
13 | count: 3
14 | class:
15 | storageClass:
16 | distribution:
17 | version:
18 | settings:
19 | network:
20 | cni:
21 | name: antrea
22 | services:
23 | cidrBlocks: ["198.51.100.0/12"]
24 | pods:
25 | cidrBlocks: ["192.0.2.0/16"]
--------------------------------------------------------------------------------
/docs/assets/images/icon-color.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/assets/stylesheets/extra.css:
--------------------------------------------------------------------------------
1 | .green {
2 | color: green;
3 | }
4 | .red {
5 | color: red;
6 | }
7 |
--------------------------------------------------------------------------------
/docs/community/code-of-conduct.md:
--------------------------------------------------------------------------------
1 | --8<-- "./CODE_OF_CONDUCT.md"
2 |
--------------------------------------------------------------------------------
/docs/community/contributing.md:
--------------------------------------------------------------------------------
1 | --8<-- "./CONTRIBUTING.md"
2 |
--------------------------------------------------------------------------------
/docs/community/index.md:
--------------------------------------------------------------------------------
1 | # Community
2 |
3 | This PowerShell module is the work of many contributors and the project team appreciates your help!
4 |
5 | Thank you for your interest in the project. Whether it's a bug report, enhancement, correction, or
6 | additional documentation, we greatly value feedback and contributions from our community.
7 |
--------------------------------------------------------------------------------
/docs/community/support.md:
--------------------------------------------------------------------------------
1 | # Support
2 |
3 | :octicons-heart-24: While this module is not supported by VMware Support Services, it is supported by the project maintainers and its community of users.
4 |
5 | :octicons-issue-opened-24: Use the GitHub [issues][issues] to report bugs or suggest enhancements.
6 |
7 | :octicons-thumbsup-24: Issues are monitored by the maintainers and are prioritized based on criticality and community [reactions][reactions].
8 |
9 | :octicons-search-24: Before opening an issue, please [search the issues][issues-search] and use the reactions to add votes to matching issues. Please include as much information as you can. Details like these are incredibly useful in helping the us evaluate and prioritize any changes:
10 |
11 | - A reproducible test case or series of steps.
12 | - Any modifications you've made relevant to the bug.
13 | - Anything unusual about your environment or deployment.
14 |
15 | :octicons-comment-discussion-24: You can also start a discussion on the GitHub [discussions][discussions] area to ask questions or share ideas.
16 |
17 | [issues]: https://github.com/vmware/power-validated-solutions-for-cloud-foundation/issues
18 | [issues-search]: https://github.com/vmware/power-validated-solutions-for-cloud-foundation/issues?q=is%3Aissue+is%3Aopen+label%3Abug
19 | [discussions]: https://github.com/vmware/power-validated-solutions-for-cloud-foundation/discussions
20 | [reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
21 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-automation/Get-vRAAPIVersion.md:
--------------------------------------------------------------------------------
1 | # Get-vRAAPIVersion
2 |
3 | ## Synopsis
4 |
5 | Retrieve the VMware Aria Automation version information
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRAAPIVersion
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRAAPIVersion` cmdlet returns the latest version of the API.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRAAPIVersion
23 | ```
24 |
25 | The example retrieves the API version of VMware Aria Automation.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-automation/Get-vRANotification.md:
--------------------------------------------------------------------------------
1 | # Get-vRANotification
2 |
3 | ## Synopsis
4 |
5 | Get notification configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRANotification
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRANotification` cmdlet gets the notification configuation from VMware Aria Automation.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRANotification
23 | ```
24 |
25 | This example gets the current notification configuration from VMware Aria Automation
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-automation/Get-vRAOrganizationId.md:
--------------------------------------------------------------------------------
1 | # Get-vRAOrganizationId
2 |
3 | ## Synopsis
4 |
5 | Get the organization ID for the logged in user
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRAOrganizationId
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRAOrganizationId` cmdlet gets the organization Id for the logged in user.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRAOrganizationId
23 | ```
24 |
25 | This example gets organization Id for the logged in user
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-automation/Remove-vRACloudZone.md:
--------------------------------------------------------------------------------
1 | # Remove-vRACloudZone
2 |
3 | ## Synopsis
4 |
5 | Remove Cloud Zones
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRACloudZone [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRACloudZone` cmdlet deletes a Cloud Zones from VMware Aria Automation.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vRACloudZone -id
23 | ```
24 |
25 | This example deletes a Cloud Zone from VMware Aria Automation by id.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The Cloud Zone id to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-automation/Remove-vRANotification.md:
--------------------------------------------------------------------------------
1 | # Remove-vRANotification
2 |
3 | ## Synopsis
4 |
5 | Remove notification configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRANotification
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRANotification` cmdlet removes the notification configuration from VMware Aria Automation.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vRANotification
23 | ```
24 |
25 | This example removes the current notification configuration from VMware Aria Automation
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIAgentGroup.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIAgentGroup
2 |
3 | ## Synopsis
4 |
5 | Get list of agent groups
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIAgentGroup
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIAgentGroup` cmdlet gets a list of agent groups.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIAgentGroup
23 | ```
24 |
25 | This example gets a list agent groups
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIAlert.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIAlert
2 |
3 | ## Synopsis
4 |
5 | Get list of alerts
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIAlert
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIGroup` cmdlet gets a list of alerts.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIGroup
23 | ```
24 |
25 | This example gets a list alerts from VMware Aria Operations for Logs
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIAuthenticationAD.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIAuthenticationAD
2 |
3 | ## Synopsis
4 |
5 | Get Active Directory configuration settings
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIAuthenticationAD
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIAuthenticationAD` cmdlet gets the Active Directory configuration settings.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIAuthenticationAD
23 | ```
24 |
25 | This example gets the the Active Directory configuration settings
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIContentPack.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIContentPack
2 |
3 | ## Synopsis
4 |
5 | Get list of installed content packs
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIContentPack
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIContentPack` cmdlet gets a list of all content packs installed on VMware Aria Operations for Logs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIContentPack
23 | ```
24 |
25 | This example gets a list of all content packs
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIEmailNotification.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIEmailNotification
2 |
3 | ## Synopsis
4 |
5 | Get list of email address for notifications
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIEmailNotification
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIEmailNotification` cmdlet gets a list of the emails notifications will be sent to in VMware Aria Operations for Logs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIEmailNotification
23 | ```
24 |
25 | This example gets a list of email notifications.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIIndexPartition.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIIndexPartition
2 |
3 | ## Synopsis
4 |
5 | Get the index partitions
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIIndexPartition
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIIndexPartition` cmdlet gets a list of index partitions in VMware Aria Operations for Logs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIIndexPartition
23 | ```
24 |
25 | This example gets a list of index partitions
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIRetentionThreshold.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIRetentionThreshold
2 |
3 | ## Synopsis
4 |
5 | Get the retention threshold configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIRetentionThreshold
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIRetentionThreshold` cmdlet gets the retention configuration in VMware Aria Operations for Logs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIRetentionThreshold
23 | ```
24 |
25 | This example gets the retention configuration
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIRole.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIRole
2 |
3 | ## Synopsis
4 |
5 | Get list of roles
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIRole
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIRole` cmdlet gets a list of roles in VMware Aria Operations for Logs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIRole
23 | ```
24 |
25 | This example gets a list of roles in VMware Aria Operations for Logs
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLISmtpConfiguration.md:
--------------------------------------------------------------------------------
1 | # Get-vRLISmtpConfiguration
2 |
3 | ## Synopsis
4 |
5 | Get SMTP server settings
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLISmtpConfiguration
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLISmtpConfiguration` cmdlet gets the SMTP server configuration in VMware Aria Operations for Logs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLISmtpConfiguration
23 | ```
24 |
25 | This example gets the SMTP settings
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Get-vRLIVersion.md:
--------------------------------------------------------------------------------
1 | # Get-vRLIVersion
2 |
3 | ## Synopsis
4 |
5 | Get VMware Aria Operations for Logs version information
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRLIVersion
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIVersion` cmdlet gets the VMware Aria Operations for Logs version information.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIVersion
23 | ```
24 |
25 | This example gets the VMware Aria Operations for Logs version information
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Remove-vRLIAlert.md:
--------------------------------------------------------------------------------
1 | # Remove-vRLIAlert
2 |
3 | ## Synopsis
4 |
5 | Delete an alerts
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRLIAlert [-alertId] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRLIGroup` cmdlet deletes an alerts.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRLIGroup -alertId
23 | ```
24 |
25 | This example deletes an alert from VMware Aria Operations for Logs.
26 |
27 | ## Parameters
28 |
29 | ### -alertId
30 |
31 | The ID of the alert to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Remove-vRLIAuthenticationAD.md:
--------------------------------------------------------------------------------
1 | # Remove-vRLIAuthenticationAD
2 |
3 | ## Synopsis
4 |
5 | Disable Active Directory as an authentication provider.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRLIAuthenticationAD
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRLIAuthenticationAD` cmdlet disbales Active Directory as an authentication provider in VMware Operations for Logs
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vRLIAuthenticationAD
23 | ```
24 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-logs/Remove-vRLIAuthenticationWSA.md:
--------------------------------------------------------------------------------
1 | # Remove-vRLIAuthenticationWSA
2 |
3 | ## Synopsis
4 |
5 | Disables Workspace ONE Access Intergration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRLIAuthenticationWSA
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRLIAuthenticationWSA` cmdlet disables Workspace ONE Access Integration.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vRLIAuthenticationWSA
23 | ```
24 |
25 | This example disables Workspace ONE Access Integration
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-networks/Get-AriaNetworksLdapConfiguration.md:
--------------------------------------------------------------------------------
1 | # Get-AriaNetworksLdapConfiguration
2 |
3 | ## Synopsis
4 |
5 | Get the LDAP configuration in VMware Aria Operations for Networks.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-AriaNetworksLdapConfiguration
11 | ```
12 |
13 | ## Description
14 |
15 | The Get-AriaNetworksLdapConfiguration cmdlet allows a user to get the LDAP configuration in VMware Aria Operations for Networks.
16 |
17 | ## Example
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-AriaNetworksLdapConfiguration
23 | ```
24 |
25 | This example gets the LDAP configuration in VMware Aria Operations for Networks.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations-networks/Remove-AriaNetworksLdapConfiguration.md:
--------------------------------------------------------------------------------
1 | # Remove-AriaNetworksLdapConfiguration
2 |
3 | ## Synopsis
4 |
5 | Removes the LDAP configuration from VMware Aria Operations for Networks.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-AriaNetworksLdapConfiguration
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-AriaNetworksLdapConfiguration` cmdlet allows a user to remove the LDAP configuration from VMware Aria Operations for Networks.
16 |
17 | ## Example
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-AriaNetworksLdapConfiguration
23 | ```
24 |
25 | This example removes the LDAP configuration from VMware Aria Operations for Networks.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Add-vROPSAdapter.md:
--------------------------------------------------------------------------------
1 | # Add-vROPSAdapter
2 |
3 | ## Synopsis
4 |
5 | Add an adapter
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Add-vROPSAdapter [-json] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Add-vROPSAdapter` cmdlet adds an adapter to VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Add-vROPSAdapter -json .\addAdapter.json
23 | ```
24 |
25 | This example adds an adapter using the json specification file.
26 |
27 | ## Parameters
28 |
29 | ### -json
30 |
31 | The JSON file to use for the add.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Add-vROPSCredential.md:
--------------------------------------------------------------------------------
1 | # Add-vROPSCredential
2 |
3 | ## Synopsis
4 |
5 | Add a credential to VMware Aria Operations
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Add-vROPSCredential [-json] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Add-vROPSCredential` cmdlet adds a credential to VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Add-vROPSCredential -json .\credentialJson
23 | ```
24 |
25 | This example adds a new credential.
26 |
27 | ## Parameters
28 |
29 | ### -json
30 |
31 | The JSON file containing the credential details.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Get-vROPSAlertPlugin.md:
--------------------------------------------------------------------------------
1 | # Get-vROPSAlertPlugin
2 |
3 | ## Synopsis
4 |
5 | Get the alert plugins
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vROPSAlertPlugin
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vROPSAlertPlugin` cmdlet gets the configured alert plugins in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vROPSAlertPlugin
23 | ```
24 |
25 | This example gets a list of the alert plugins configure in VMware Aria Operations.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Get-vROPSAuthRole.md:
--------------------------------------------------------------------------------
1 | # Get-vROPSAuthRole
2 |
3 | ## Synopsis
4 |
5 | Get all the roles available in the system
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vROPSAuthRole [[-name] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vROPSAuthRole` cmdlet gets all the roles available in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vROPSAuthRole
23 | ```
24 |
25 | This example gets all the roles available.
26 |
27 | ## Parameters
28 |
29 | ### -name
30 |
31 | The name of the role to get.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Get-vROPSCurrency.md:
--------------------------------------------------------------------------------
1 | # Get-vROPSCurrency
2 |
3 | ## Synopsis
4 |
5 | Get the currency configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vROPSCurrency
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vROPSCurrency` cmdlet gets the currency configuration for VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vROPSCurrency
23 | ```
24 |
25 | This example gets the currency configuration for VMware Aria Operations.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Get-vROPSNotification.md:
--------------------------------------------------------------------------------
1 | # Get-vROPSNotification
2 |
3 | ## Synopsis
4 |
5 | Get list of all notifications
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vROPSNotification [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vROPSNotification` cmdlet gets list of all notifications in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vROPSNotification
23 | ```
24 |
25 | This example gets a list of all notifications.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The ID of the notification to get.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Get-vROpsLogForwarding.md:
--------------------------------------------------------------------------------
1 | # Get-vROpsLogForwarding
2 |
3 | ## Synopsis
4 |
5 | Gets the VMware Aria Operations logging forwarding configuration.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vROpsLogForwarding
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vROpsLogForwarding` cmdlet gets the VMware Aria Operations logging forwarding configuration.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vROpsLogForwarding
23 | ```
24 |
25 | This example returns the logging forwarding configuration on VMware Aria Operations.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Remove-vROPSAdapter.md:
--------------------------------------------------------------------------------
1 | # Remove-vROPSAdapter
2 |
3 | ## Synopsis
4 |
5 | Delete an adapters
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vROPSAdapter [-id] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vROPSAdapter` cmdlet deletes an adapters from VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vROPSAdapter [-id]
23 | ```
24 |
25 | This example deletes the adapter based on its ID.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The ID of the adapter to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Remove-vROPSCollectorGroup.md:
--------------------------------------------------------------------------------
1 | # Remove-vROPSCollectorGroup
2 |
3 | ## Synopsis
4 |
5 | Delete a collector group
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vROPSCollectorGroup [-id] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vROPSCollectorGroup` cmdlet deletes a collector group in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vROPSCollectorGroup -id
23 | ```
24 |
25 | This example deletes a collector group.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The ID of the collector group to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Remove-vROPSCredential.md:
--------------------------------------------------------------------------------
1 | # Remove-vROPSCredential
2 |
3 | ## Synopsis
4 |
5 | Delete a credential
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vROPSCredential [-credentialId] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vROPSCredential` cmdlet deletes a credential from VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vROPSCredential [-credentialId]
23 | ```
24 |
25 | This example deletes a credential.
26 |
27 | ## Parameters
28 |
29 | ### -credentialId
30 |
31 | The ID of the credential to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Remove-vROPSNotification.md:
--------------------------------------------------------------------------------
1 | # Remove-vROPSNotification
2 |
3 | ## Synopsis
4 |
5 | Delete a notification
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vROPSNotification [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vROPSNotification` cmdlet deletes a notifications in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vROPSNotification [[-id] ]
23 | ```
24 |
25 | This example deletes a notifications.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The ID of the notification to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Remove-vROPSUserGroup.md:
--------------------------------------------------------------------------------
1 | # Remove-vROPSUserGroup
2 |
3 | ## Synopsis
4 |
5 | Deletes a user group
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vROPSUserGroup [-id] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vROPSUserGroup` cmdlet deletes a user group from VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vROPSUserGroup [-id]
23 | ```
24 |
25 | This example deletes a user group from VMware Aria Operations.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The ID of the user group to delete.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Start-vROPSAdapter.md:
--------------------------------------------------------------------------------
1 | # Start-vROPSAdapter
2 |
3 | ## Synopsis
4 |
5 | Starts collection of adapter
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Start-vROPSAdapter [-adapterId] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Start-vROPSAdapter` cmdlet starts the collection of an adapter in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Start-vROPSAdapter -adapterId
23 | ```
24 |
25 | This example starts the adapter by id.
26 |
27 | ## Parameters
28 |
29 | ### -adapterId
30 |
31 | The ID of the adapter to start.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-operations/Stop-vROPSAdapter.md:
--------------------------------------------------------------------------------
1 | # Stop-vROPSAdapter
2 |
3 | ## Synopsis
4 |
5 | Stops collection of adapter
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Stop-vROPSAdapter [-adapterId] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Stop-vROPSAdapter` cmdlet starts the collection of an adapter in VMware Aria Operations.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Stop-vROPSAdapter -adapterId
23 | ```
24 |
25 | This example starts the adpater by id.
26 |
27 | ## Parameters
28 |
29 | ### -adapterId
30 |
31 | The ID of the adapter to stop.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMApplianceNtpConfig.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMApplianceNtpConfig
2 |
3 | ## Synopsis
4 |
5 | Get appliance NTP configuration in VMware Aria Suite Lifecycle
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRSLCMApplianceNtpConfig
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMApplianceNtpConfig` cmdlet gets appliance NTP configuration in VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRSLCMApplianceNtpConfig
23 | ```
24 |
25 | This example gets the appliance NTP configuration in VMware Aria Suite Lifecycle.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMGroup.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMGroup
2 |
3 | ## Synopsis
4 |
5 | Retrieve group assignments in VMware Aria Suite Lifecycle.
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Get-vRSLCMGroup [[-providerVmid] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMGroup` cmdlet retrieves a list of group assignments in VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Get-vRSLCMGroup
23 | ```
24 |
25 | This example retrieves a list of VMware Aria Suite Lifecycle group assignments.
26 |
27 | ### Example 2
28 |
29 | ``` PowerShell
30 | Get-vRSLCMGroup -providerVmid 2d90903c-b753-4f52-905e-5421d11f6572
31 | ```
32 |
33 | This example retrieves a list of VMware Aria Suite Lifecycle group assignments for the given identity provider.
34 |
35 | ## Parameters
36 |
37 | ### -providerVmid
38 |
39 | The vmid for the provider.
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMHealth.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMHealth
2 |
3 | ## Synopsis
4 |
5 | Check VMware Aria Suite Lifecycle Health Status
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRSLCMHealth
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMHealth` cmdlet checks VMware Aria Suite Lifecycle Health Status.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRSLCMHealth
23 | ```
24 |
25 | This example checks VMware Aria Suite Lifecycle Health Status
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMMyVmwareAccount.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMMyVmwareAccount
2 |
3 | ## Synopsis
4 |
5 | Get My VMware accounts from VMware Aria Suite Lifecycle
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRSLCMMyVmwareAccount
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMMyVmwareAccount` cmdlet retrieves the My VMware accounts assigned in VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRSLCMMyVmwareAccount
23 | ```
24 |
25 | This example retrieves all the My VMware Accounts assigned in VMware Aria Suite Lifecycle.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMProductBinariesMapped.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMProductBinariesMapped
2 |
3 | ## Synopsis
4 |
5 | Get list of mapped product binaries
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRSLCMProductBinariesMapped
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMProductBinariesMapped` cmdlet retrieves a list of mapped product binaries in VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRSLCMProductBinariesMapped
23 | ```
24 |
25 | This example retrieves a list of mapped Product Binaries in VMware Aria Suite Lifecycle.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMRole.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMRole
2 |
3 | ## Synopsis
4 |
5 | Retrieve VMware Aria Suite Lifecycle roles.
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Get-vRSLCMRole
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMRole` cmdlet retrieves a list of VMware Aria Suite Lifecycle roles.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Get-vRSLCMRole
23 | ```
24 |
25 | This example retrieves a list of VMware Aria Suite Lifecycle roles.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Get-vRSLCMSshStatus.md:
--------------------------------------------------------------------------------
1 | # Get-vRSLCMSshStatus
2 |
3 | ## Synopsis
4 |
5 | Get the status of the SSH service in VMware Aria Suite Lifecycle.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-vRSLCMSshStatus
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-vRSLCMSshStatus` cmdlet gets the status of the SSH Server in VMware Aria Suite Lifecycle
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-vRSLCMSshStatus
23 | ```
24 |
25 | This example gets the SSH services.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Import-vRSLCMPSPack.md:
--------------------------------------------------------------------------------
1 | # Import-vRSLCMPSPack
2 |
3 | ## Synopsis
4 |
5 | Import a Product Support Pack.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Import-vRSLCMPSPack [[-psPackFile] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Import-vRSLCMPSPack` cmdlet imports a Product Support Pack into VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Import-vRSLCMPSPack -psPackFile vrlcm-8.14.0-PSPACK8.pspak
23 | ```
24 |
25 | This example imports a Product Support Pack into VMware Aria Suite Lifecycle.
26 |
27 | ## Parameters
28 |
29 | ### -psPackFile
30 |
31 | The Product Support Pack to import.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ## Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMGroup.md:
--------------------------------------------------------------------------------
1 | # Remove-vRSLCMGroup
2 |
3 | ## Synopsis
4 |
5 | Remove a group and its role assignments from VMware Aria Suite Lifecycle.
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Remove-vRSLCMGroup [-vmid] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRSLCMGroup` cmdlet removes a group and its role assignments from VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Remove-vRSLCMGroup -vmid a3f18959-00b1-4703-a9ab-fad5de8efa84
23 | ```
24 |
25 | This example removes a group and its role assignments from VMware Aria Suite Lifecycle.
26 |
27 | ## Parameters
28 |
29 | ### -vmid
30 |
31 | The unique identifier of the group in VMware Aria Suite Lifecycle.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMLockerLicense.md:
--------------------------------------------------------------------------------
1 | # Remove-vRSLCMLockerLicense
2 |
3 | ## Synopsis
4 |
5 | Delete a License based on vmid
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRSLCMLockerLicense [-vmid] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRSLCMLockerLicense` cmdlet deletes a license from the locker.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vRSLCMLockerLicense -vmid
23 | ```
24 |
25 | This example deletes the license with the vmid.
26 |
27 | ## Parameters
28 |
29 | ### -vmid
30 |
31 | The vmid of the license.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Remove-vRSLCMLockerPassword.md:
--------------------------------------------------------------------------------
1 | # Remove-vRSLCMLockerPassword
2 |
3 | ## Synopsis
4 |
5 | Delete a password based on vmid
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-vRSLCMLockerPassword [-vmid] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-vRSLCMLockerPassword` cmdlet deletes a password from the locker.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-vRSLCMLockerPassword -vmid
23 | ```
24 |
25 | This example delets the password with the vmid`.
26 |
27 | ## Parameters
28 |
29 | ### -vmid
30 |
31 | The vmid of the password.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/aria-suite/aria-suite-lifecycle/Watch-vRSLCMRequest.md:
--------------------------------------------------------------------------------
1 | # Watch-vRSLCMRequest
2 |
3 | ## Synopsis
4 |
5 | Poll request
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Watch-vRSLCMRequest [[-vmid] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Watch-vRSLCMRequest` cmdlet polls a request in VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Watch-vRSLCMRequest -vmid
23 | ```
24 |
25 | This example polls the request in VMware Aria Suite Lifecycle.
26 |
27 | ## Parameters
28 |
29 | ### -vmid
30 |
31 | The vmid of the request.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtCertificate.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtCertificate
2 |
3 | ## Synopsis
4 |
5 | Gets NSX Certificates
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtCertificate [[-certificateName] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtCertificates` cmdlet gets certificates installed in NSX.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtCertificates
23 | ```
24 |
25 | This example gets the certificates installed in NSX.
26 |
27 | ## Parameters
28 |
29 | ### -certificateName
30 |
31 | The name of the certificate.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtEdgeCluster.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtEdgeCluster
2 |
3 | ## Synopsis
4 |
5 | Gets NSX Edge Cluster Id
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtEdgeCluster
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtEdgeCluster` cmdlet gets the NSX Edge Cluster Id.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtEdgeCluster
23 | ```
24 |
25 | This example returns the NSX Edge Cluster Id
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtEdgeNode.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtEdgeNode
2 |
3 | ## Synopsis
4 |
5 | Get details for NSX Edge.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtEdgeNode [-transportNodeId] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtEdgeNode` cmdlet returns the details of an NSX Edge node.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtEdgeNode -transportNodeId 7740f2da-83b5-40de-bc4c-665ea779bbd0
23 | ```
24 |
25 | This example returns the details of an NSX Edge node.
26 |
27 | ## Parameters
28 |
29 | ### -transportNodeId
30 |
31 | The id of the NSX Edge node.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManager.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManager
2 |
3 | ## Synopsis
4 |
5 | Retrieve a list of NSX Global Managers.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManager [[-id] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManager` cmdlet retrieves a list of NSX Global Managers.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManager
23 | ```
24 |
25 | This example retrieves a list of NSX Global Managers.
26 |
27 | ### Example 2
28 |
29 | ```powershell
30 | Get-NsxtGlobalManager -id SFOGM
31 | ```
32 |
33 | This example retrieves the details of the SFOGM NSX Global Manager.
34 |
35 | ## Parameters
36 |
37 | ### -id
38 |
39 | The ID of the Global Manager.
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerBackupOverview.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerBackupOverview
2 |
3 | ## Synopsis
4 |
5 | Return the backup history for an NSX Local Manager instance.
6 |
7 | ## SYNTAX
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerBackupOverview [-siteId] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerBackupOverview` cmdlet returns the backup history for an NSX Local Manager instance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerBackupOverview -siteId sfo-w01-nsx01.sfo.rainpole.io
23 | ```
24 |
25 | This example returns the backup history for a NSX Local Manager instance based on the site ID.
26 |
27 | ## Parameters
28 |
29 | ### -siteId
30 |
31 | The siteId of the NSX Local Manager.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerCertificateResult.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerCertificateResult
2 |
3 | ## Synopsis
4 |
5 | Retrieve the status of applied certificate from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerCertificateResult
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerCertificateResult` cmdlet retrieves the status of the applied certificate from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerCertificateResult
23 | ```
24 |
25 | This example retrieves the status of the applied certificate from the NSX Global Manager.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerCluster.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerCluster
2 |
3 | ## Synopsis
4 |
5 | Retrieve the NSX Global Manager cluster details.
6 |
7 | ## Syntax
8 |
9 | ```powershll
10 | Get-NsxtGlobalManagerCluster
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerCluster` cmdlet retrieves the NSX Global Manager cluster details.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerCluster
23 | ```
24 |
25 | This example retrieves the NSX Global Manager cluster details.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerClusterVirtualIp.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerClusterVirtualIp
2 |
3 | ## Synopsis
4 |
5 | Retrieve the NSX Global Manager cluster virtual IPs.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerClusterVirtualIp
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerClusterVirtualIp` cmdlet retrieves the NSX Global Manager cluster virtual IPs.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerClusterVirtualIp
23 | ```
24 |
25 | This example retrieves the NSX Global Manager cluster virtual IPs.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerConfig.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerConfig
2 |
3 | ## Synopsis
4 |
5 | Retrieve the NSX Global Manager configuration.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerConfig [-localManager] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerConfig` cmdlet retrieves the NSX Global Manager configuration.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerConfig
23 | ```
24 |
25 | This example retrieves the NSX Global Manager configuration.
26 |
27 | ### Example 2
28 |
29 | ```powershell
30 | Get-NsxtGlobalManagerConfig -localManager
31 | ```
32 |
33 | This example retrieves the NSX Global Manager configuration from the NSX Local Manager.
34 |
35 | ## PARAMETERS
36 |
37 | ### -localManager
38 |
39 | Parameter to retrieve the NSX Global Manager configuration from an NSX Local Manager.
40 |
41 | ```yaml
42 | Type: SwitchParameter
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: Named
48 | Default value: False
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerEdgeCluster.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerEdgeCluster
2 |
3 | ## Synopsis
4 |
5 | Retrieve the NSX Edge cluster information for the specified site.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerEdgeCluster [-siteId] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerEdgeCluster` cmdlet retrieves the NSX Edge cluster information for the specified site.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerEdgeCluster -siteId sfo-m01
23 | ```
24 |
25 | This example retrieves the NSX Edge cluster information for the specified site.
26 |
27 | ## PARAMETERS
28 |
29 | ### -siteId
30 |
31 | The ID of the site.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerOperationalState.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerOperationalState
2 |
3 | ## Synopsis
4 |
5 | Retrieve the NSX Global Manager operational state.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerOperationalState
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerOperationalState` cmdlet retrieves the NSX Global Manager operational state.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerOperationalState
23 | ```
24 |
25 | This example retrieves the NSX Global Manager operational state.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerSegment.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerSegment
2 |
3 | ## Synopsis
4 |
5 | Retrieve the list of configured segments from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerSegment [[-segmentId] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerSegment` cmdlet retrieves the list of configured segments from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerSegment
23 | ```
24 |
25 | This example retrieves the list of configured segments from the NSX Global Manager.
26 |
27 | ### Example 2
28 |
29 | ```powershell
30 | Get-NsxtGlobalManagerSegment -segmentId "799a0af5-d89b-437b-836f-61361e114f6e"
31 | ```
32 |
33 | This example retrieves a configured segment from the NSX Global Manager.
34 |
35 | ## Parameters
36 |
37 | ### -segmentId
38 |
39 | The ID of the segment in the NSX Global Manager.
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerTier0Gateway.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerTier0Gateway
2 |
3 | ## Synopsis
4 |
5 | Retrieve a list of Tier-0 gateways from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerTier0Gateway [[-id] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerTier0Gateway` cmdlet retrieves a list of Tier-0 gateways from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerTier0Gateway
23 | ```
24 |
25 | This example retrieves a list of Tier-0 gateways from the NSX Global Manager.
26 |
27 | ### Example 2
28 |
29 | ```powershell
30 | Get-NsxtGlobalManagerTier0Gateway -id "92a3a3b4-a1d1-48a9-8190-dca8e44c18c1"
31 | ```
32 |
33 | This example retrieves a list of Tier-0 gateways from the NSX Global Manager.
34 |
35 | ## Parameters
36 |
37 | ### -id
38 |
39 | The ID of the Tier-0 Gateway.
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerTier0LocaleServices.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerTier0LocaleServices
2 |
3 | ## Synopsis
4 |
5 | Retrieve the locale services of the Tier-0 gateway from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerTier0LocaleServices [-tier0GatewayId] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerTier0LocaleServices` cmdlet retrieves the locale services of the Tier-0 gateway from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerTier0LocaleServices -tier0GatewayId "959e3558-98cc-4484-91a2-36ad6bfc5594"
23 | ```
24 |
25 | This example retrieves the locale services of the Tier-0 gateway from the NSX Global Manager.
26 |
27 | ## Parameters
28 |
29 | ### -tier0GatewayId
30 |
31 | The ID of the Tier 0 Gateway.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerTier1Gateway.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerTier1Gateway
2 |
3 | ## Synopsis
4 |
5 | Retrieve a list of Tier-1 gateways from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerTier1Gateway [[-id] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerTier1Gateway` cmdlet retrieves a list of Tier-1 gateways from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerTier1Gateway
23 | ```
24 |
25 | This example retrieves a list of Tier-1 gateways from the NSX Global Manager.
26 |
27 | ### Example 2
28 |
29 | ```powershell
30 | Get-NsxtGlobalManagerTier1Gateway -id xint-m01-ec01-t1-gw01
31 | ```
32 |
33 | This example retrieves a list of Tier-1 gateways from the NSX Global Manager.
34 |
35 | ## Parameters
36 |
37 | ### -id
38 |
39 | The ID of the Tier-1 Gateway.
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGlobalManagerTier1LocaleServices.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGlobalManagerTier1LocaleServices
2 |
3 | ## Synopsis
4 |
5 | Retrieve the locale services of the Tier-1 gateway from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGlobalManagerTier1LocaleServices [-tier1GatewayId] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGlobalManagerTier1LocaleServices` cmdlet retrieves the locale services of the Tier-1 gateway from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerTier1LocaleServices -tier1GatewayId "959e3558-98cc-4484-91a2-36ad6bfc5594"
23 | ```
24 |
25 | This example retrieves the locale services of the Tier-1 gateway from the NSX Global Manager.
26 |
27 | ## Parameters
28 |
29 | ### -tier1GatewayId
30 |
31 | The ID of the Tier 1 Gateway.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtGroup.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtGroup
2 |
3 | ## Synopsis
4 |
5 | Get groups
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtGroup [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtGroup` cmdlet returns a paginated list of groups.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGroup
23 | ```
24 |
25 | This example retrieves a paginated list of all groups.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The id of the group.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtIpPool.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtIpPool
2 |
3 | ## Synopsis
4 |
5 | Retrieve IPs pools.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtIpPool [[-id] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtIpPool` cmdlet retrieves the IP pools from NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtIpPool
23 | ```
24 |
25 | This example retrieves the IP pools from NSX Manager.
26 |
27 | ### Example 2
28 |
29 | ```powershell
30 | Get-NsxtIpPool -id sfo-m01-r01-ip-pool-rtep
31 | ```
32 |
33 | This example retrieves the IP pools with the supplied ID from NSX Manager.
34 |
35 | ## Parameters
36 |
37 | ### -id
38 |
39 | The ID of the IP Pool.
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtLogicalRouter.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtLogicalRouter
2 |
3 | ## Synopsis
4 |
5 | Get Logical Routers
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtLogicalRouter
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtLogicalRouter` cmdlet retrieves a list of logical routers.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtLogicalRouter
23 | ```
24 |
25 | This example gets all logical routers
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtRole.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtRole
2 |
3 | ## Synopsis
4 |
5 | Gets NSX Manager roles
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtRole
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtRole` cmdlet gets the roles in NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtRole
23 | ```
24 |
25 | This example gets all roles in NSX Manager.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtUser.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtUser
2 |
3 | ## Synopsis
4 |
5 | Gets all users and groups
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtUser
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtUser` cmdlet gets all users and groups in NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtUser
23 | ```
24 |
25 | This example gets all users and groups in NSX Manager.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtVidm.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtVidm
2 |
3 | ## Synopsis
4 |
5 | Get Identity Manager configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtVidm
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtVidm` cmdlet gets the Identity Manager configuration.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtVidm
23 | ```
24 |
25 | This example gets the Identity Manager configuration.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtVidmGroup.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtVidmGroup
2 |
3 | ## Synopsis
4 |
5 | Gets Identity Manager groups
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtVidmGroup [-searchString] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtVidmGroup` cmdlet gets all Identity Manager groups from NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtVidmGroup -searchString gg-
23 | ```
24 |
25 | This example gets all Identity Manager groups starting with gg- from NSX Manager.
26 |
27 | ## Parameters
28 |
29 | ### -searchString
30 |
31 | The search string.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtVidmStatus.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtVidmStatus
2 |
3 | ## Synopsis
4 |
5 | Get the status of the Identity Manager integration.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtVidmStatus
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtVidmStatus` cmdlet returns the status of the Identity Manager integration.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtVidmStatus
23 | ```
24 |
25 | This example returns the status of the Identity Manager integration.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Get-NsxtVidmUser.md:
--------------------------------------------------------------------------------
1 | # Get-NsxtVidmUser
2 |
3 | ## Synopsis
4 |
5 | Gets Identity Manager users
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-NsxtVidmUser [-searchString] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-NsxtVidmUser` cmdlet gets all Identity Manager users from NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtVidmUser -searchString svc
23 | ```
24 |
25 | This example gets all Identity Manager users starting with 'svc' from NSX Manager.
26 |
27 | ## Parameters
28 |
29 | ### -searchString
30 |
31 | The search string.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/New-NsxtIpPool.md:
--------------------------------------------------------------------------------
1 | # New-NsxtIpPool
2 |
3 | ## Synopsis
4 |
5 | Create an IP pool.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | New-NsxtIpPool [-poolName] [[-description] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `New-NsxtIpPool` cmdlet creates an IP pool in NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | New-NsxtIpPool -poolName sfo-m01-r01-ip-pool-rtep -description "RTEP IP Pool"
23 | ```
24 |
25 | This example creates an IP pool in NSX Manager.
26 |
27 | ## Parameters
28 |
29 | ### -poolName
30 |
31 | The name of the IP Pool.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -description
46 |
47 | The description of the IP Pool.
48 |
49 | ```yaml
50 | Type: String
51 | Parameter Sets: (All)
52 | Aliases:
53 |
54 | Required: False
55 | Position: 2
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerClusterNode.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtGlobalManagerClusterNode
2 |
3 | ## Synopsis
4 |
5 | Remove an NSX Global Manager from a cluster.
6 |
7 | ## Syntax
8 |
9 | ```powersehll
10 | Remove-NsxtGlobalManagerClusterNode [-uuid] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtGlobalManagerClusterNode` cmdlet removes an NSX Global Manager from a cluster.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtGlobalManagerClusterNode -uuid f1563a42-ebe0-406b-3255-8d8fbc70cb91
23 | ```
24 |
25 | This example removes an NSX Global Manager from a cluster.
26 |
27 | ## Parameters
28 |
29 | ### -uuid
30 |
31 | The unique identifier for the node to be removed from the cluster.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerClusterVirtualIp.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtGlobalManagerClusterVirtualIp
2 |
3 | ## Synopsis
4 |
5 | Remove a NSX Global Manager cluster virtual IP.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtGlobalManagerClusterVirtualIp [[-protocol] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtGlobalManagerClusterVirtualIp` cmdlet removes a NSX Global Manager cluster virtual IP.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtGlobalManagerClusterVirtualIp -protocol IPv4
23 | ```
24 |
25 | This example removes the IPv4 NSX Global Manager cluster virtual IP.
26 |
27 | ### Example 2
28 |
29 | ```powerhell
30 | Remove-NsxtGlobalManagerClusterVirtualIp -protocol IPv6
31 | ```
32 |
33 | This example removes the IPv6 NSX Global Manager cluster virtual IP.
34 |
35 | ## Parameters
36 |
37 | ### -protocol
38 |
39 | The protocol to remove the cluster virtual IP. (One of IPv4 or IPv6)
40 |
41 | ```yaml
42 | Type: String
43 | Parameter Sets: (All)
44 | Aliases:
45 |
46 | Required: False
47 | Position: 1
48 | Default value: None
49 | Accept pipeline input: False
50 | Accept wildcard characters: False
51 | ```
52 |
53 | ### Common Parameters
54 |
55 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
56 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerLocation.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtGlobalManagerLocation
2 |
3 | ## Synopsis
4 |
5 | Deletes the location configured in NSX Global Manager.
6 |
7 | ## SYNTAX
8 |
9 | ```powershell
10 | Remove-NsxtGlobalManagerLocation [[-location] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtGlobalManagerLocation` cmdlet deletes the location configured in an NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtGlobalManagerLocation -location sfo-m01
23 | ```
24 |
25 | This example deletes the location sfo-m01 from an NSX Global Manager.
26 |
27 | ## Parameters
28 |
29 | ### -location
30 |
31 | The name of the location.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerTier0Gateway.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtGlobalManagerTier0Gateway
2 |
3 | ## Synopsis
4 |
5 | Delete the Tier 0 Gateway from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtGlobalManagerTier0Gateway [-tier0GatewayId] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtGlobalManagerTier0Gateway` cmdlet deletes the Tier 0 Gateway from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powersehll
22 | Remove-NsxtGlobalManagerTier0Gateway -tier0GatewayId "lax-m01-ec01-t0-gw01"
23 | ```
24 |
25 | This example deletes the Tier 0 Gateway from the NSX Global Manager.
26 |
27 | ## Parameters
28 |
29 | ### -tier0GatewayId
30 |
31 | The ID of the NSX Tier0 Gateway to be deleted.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerTier1Gateway.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtGlobalManagerTier1Gateway
2 |
3 | ## Synopssi
4 |
5 | Delete the Tier 1 Gateway from the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtGlobalManagerTier1Gateway [-tier1GatewayId] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtGlobalManagerTier1Gateway` cmdlet deletes the Tier 1 Gateway from the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtGlobalManagerTier1Gateway -tier1GatewayId xint-m01-ec01-t1-gw01
23 | ```
24 |
25 | This example deletes the Tier 1 Gateway from the NSX Global Manager.
26 |
27 | ## Parameters
28 |
29 | ### -tier1GatewayId
30 |
31 | The ID of the NSX Tier1 Gateway to be deleted.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtGroup.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtGroup
2 |
3 | ## Synopsis
4 |
5 | Remove a group
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtGroup [-id] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtGroup` cmdlet removes a group.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtGroup -id
23 | ```
24 |
25 | This example removes the specified security policy.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The id of the group.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtIpPool.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtIpPool
2 |
3 | ## Synopsis
4 |
5 | Delete an IP pool.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtIpPool [-id] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtIpPool` cmdlet deletes the IP pool from NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtIpPool -id sfo-m01-r01-ip-pool-rtep
23 | ```
24 |
25 | This example deletes the IP pool with the supplied ID from NSX Manager.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The ID of the IP Pool.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtLdap.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtLdap
2 |
3 | ## Synopsis
4 |
5 | Delete LDAP identity source
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtLdap [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtLdap` cmdlet removes an LDAP identity source.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtLdap -id sfo
23 | ```
24 |
25 | This example deletes an LDAP identity source.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The LDAP identity source ID.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtRole.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtRole
2 |
3 | ## Synopsis
4 |
5 | Delete a user/group role assignment
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtRole [-id] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtRole` cmdlet removes a user/group role in NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtRole -id
23 | ```
24 |
25 | This example removes the role for the user/group based on the id.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The role ID.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtSecurityPolicy.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtSecurityPolicy
2 |
3 | ## Synopsis
4 |
5 | Remove a security policy
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtSecurityPolicy [-id] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtSecurityPolicy` cmdlet removes a security policy.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtSecurityPolicy -id
23 | ```
24 |
25 | This example removes the specified security policy.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The id of the security policy.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Remove-NsxtSegment.md:
--------------------------------------------------------------------------------
1 | # Remove-NsxtSegment
2 |
3 | ## Synopsis
4 |
5 | Removes a named Segment
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-NsxtSegment [-name] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-NsxtSegment` cmdlet removes a named segment.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-NsxtSegment -name sfo-w01-kub-seg01
23 | ```
24 |
25 | This example removes the segment with the name sfo-w01-kub-seg01.
26 |
27 | ## Parameters
28 |
29 | ### -name
30 |
31 | The Segment name.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Set-NsxtGlobalManagerClusterVirtualIp.md:
--------------------------------------------------------------------------------
1 | # Set-NsxtGlobalManagerClusterVirtualIp
2 |
3 | ## Synopsis
4 |
5 | Configures a NSX Global Manager cluster virtual IP.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Set-NsxtGlobalManagerClusterVirtualIp [[-virtualIp] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Set-NsxtGlobalManagerClusterVirtualIp` cmdlet configures an NSX Global Manager cluster virtual IP.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Set-NsxtGlobalManagerClusterVirtualIp -virtualIp 172.20.11.81
23 | ```
24 |
25 | This example configures the IPv4 NSX Global Manager cluster virtual IP.
26 |
27 | ## Parameters
28 |
29 | ### -virtualIp
30 |
31 | The IP address of the cluster virtual IP.
32 |
33 | ```yaml
34 | Type: IPAddress
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Set-NsxtGloblaManagerActive.md:
--------------------------------------------------------------------------------
1 | # Set-NsxtGloblaManagerActive
2 |
3 | ## Synopsis
4 |
5 | Sets the NSX Global Manager to active mode.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Set-NsxtGloblaManagerActive [-displayName] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Set-NsxtGloblaManagerActive` cmdlet sets the NSX Global Manager to active mode.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Set-NsxtGloblaManagerActive -displayName sfo-m01-nsx-gm01
23 | ```
24 |
25 | This example sets the NSX Global Manager to Active mode with the display name sfo-m01-nsx-gm01.
26 |
27 | ## Parameters
28 |
29 | ### -displayName
30 |
31 | Display name to be assigned to the active NSX Global Manager.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Set-NsxtMtuRemoteTunnelEndpoint.md:
--------------------------------------------------------------------------------
1 | # Set-NsxtMtuRemoteTunnelEndpoint
2 |
3 | ## Synopsis
4 |
5 | Set the MTU for the Remote Tunnel Endpoint
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Set-NsxtMtuRemoteTunnelEndpoint [-mtu] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Set-NsxtMtuRemoteTunnelEndpoint` cmdlet configures the MTU for the Remote Tunnel Endpoint.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Set-NsxtMtuRemoteTunnelEndpoint -mtu 9000
23 | ```
24 |
25 | This example configures the MTU for the Remote Tunnel Endpoint.
26 |
27 | ## Parameters
28 |
29 | ### -mtu
30 |
31 | The MTU size for the Remote Tunnel Endpoint
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Start-NsxtBackup.md:
--------------------------------------------------------------------------------
1 | # Start-NsxtBackup
2 |
3 | ## Synopsis
4 |
5 | Start the backup of NSX Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Start-NsxtBackup
11 | ```
12 |
13 | ## Description
14 |
15 | The `Start-NsxtBackup` cmdlet starts the backup of NSX Manager.
16 |
17 | ## Examples
18 |
19 | ### Exmaple 1
20 |
21 | ```powershell
22 | Start-NsxtBackup
23 | ```
24 |
25 | This example starts a backup of NSX Manager.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/nsx/Test-NsxtGlobalManagerCertificate.md:
--------------------------------------------------------------------------------
1 | # Test-NsxtGlobalManagerCertificate
2 |
3 | ## Synopsis
4 |
5 | Verify the status of the imported certificate on the NSX Global Manager.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Test-NsxtGlobalManagerCertificate [[-certificateId] ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-NsxtGlobalManagerCertificate` cmdlet verifies the status of the imported certificate on the NSX Global Manager.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-NsxtGlobalManagerCertificate -certificateId f64fe940-9569-4621-940f-90ea2adafd93
23 | ```
24 |
25 | This example verifies the status of the imported certificate on the NSX Global Manager.
26 |
27 | ## Parameters
28 |
29 | ### -certificateId
30 |
31 | The ID of the certificate in the NSX Global Manager.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/site-recovery-manager/Get-SrmApplianceDetail.md:
--------------------------------------------------------------------------------
1 | # Get-SrmApplianceDetail
2 |
3 | ## Synopsis
4 |
5 | Get information about the Site Recovery Manager appliance.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-SrmApplianceDetail
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-SrmApplianceDetail` cmdlet retrieves information about the Site Recovery Manager appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-SrmApplianceDetail
23 | ```
24 |
25 | This example retrieves information about the Site Recovery Manager appliance.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/site-recovery-manager/Get-SrmNetworkAll.md:
--------------------------------------------------------------------------------
1 | # Get-SrmNetworkAll
2 |
3 | ## Synopsis
4 |
5 | Get all network configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-SrmNetworkAll
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-SrmNetworkAll` cmdlet retrieves all the network configuration of a Site Recovery Manager appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-SrmNetworkAll
23 | ```
24 |
25 | This example retrieves all network configuration of the Site Recovery Manager appliance.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/site-recovery-manager/Get-SrmNetworkDns.md:
--------------------------------------------------------------------------------
1 | # Get-SrmNetworkDns
2 |
3 | ## Synopsis
4 |
5 | Get DNS configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-SrmNetworkDns
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-SrmNetworkDns` cmdlet retrieves DNS configuration of a Site Recovery Manager appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-SrmNetworkDns
23 | ```
24 |
25 | This example retrieves information about the DNS configuration of the Site Recovery Manager appliance.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/site-recovery-manager/Get-SrmNetworkInterface.md:
--------------------------------------------------------------------------------
1 | # Get-SrmNetworkInterface
2 |
3 | ## Synopsis
4 |
5 | Get network interface configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-SrmNetworkInterface
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-SrmNetworkInterface` cmdlet retrieves network interface configuration of a Site Recovery Manager appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-SrmNetworkInterface
23 | ```
24 |
25 | This example retrieves information about the network interface configuration of the Site Recovery Manager appliance.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/site-recovery-manager/Get-SrmSitePairing.md:
--------------------------------------------------------------------------------
1 | # Get-SrmSitePairing
2 |
3 | ## Synopsis
4 |
5 | Retrieve site pairing information from a Site Recovery Manager instance.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-SrmSitePairing
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-SrmSitePairing` cmdlet retrieves site pairing information from a Site Recovery Manager instance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-SrmSitePairing
23 | ```
24 |
25 | This example retrieves site pairings from the Site Recovery Manager instance.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbr/Invoke-CbrDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-CbrDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end Deployment of Cloud-Based Ransomware Recovery
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-CbrDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-CbrDeployment` cmdlet is a single function to implement the configuration of the Cloud-Based Ransomware Recovery for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-CbrDeployment -jsonFile .\cbrDeploySpec.json
23 | ```
24 |
25 | This example configures Cloud-Based Ransomware Recovery for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbr/Invoke-CbrSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-CbrSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Cloud-Based Ransomware Recovery.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-CbrSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-CbrSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Cloud-Based Ransomware Recovery for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-CbrSolutionInterop -jsonFile .\cbrDeploySpec.json
25 | ```
26 |
27 | This example configures solution interoperability of the Cloud-Based Ransomware Recovery for VMware Cloud Foundation using the JSON spec supplied.
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbr/Invoke-UndoCbrDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoCbrDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end removal of Cloud-Based Ransomware Recovery
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-UndoCbrDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoCbrDeployment` cmdlet is a single function to removal the configuration of the Cloud-Based Ransomware Recovery for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-UndoCbrDeployment -jsonFile .\cbrDeploySpec.json
23 | ```
24 |
25 | This example removes Cloud-Based Ransomware Recovery for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbr/Invoke-UndoCbrSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoCbrSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Cloud-Based Ransomware Recovery.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoCbrSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoCbrSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Cloud-Based Ransomware Recovery for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-UndoCbrSolutionInterop -jsonFile .\cbrDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Cloud-Based Ransomware Recovery for VMware Cloud Foundation using the JSON spec supplied.
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbr/Test-CbrPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-CbrPrerequisite
2 |
3 | ## Synopsis
4 |
5 | Verify the prerequisites for Cloud-Based Ransomware Recovery
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Test-CbrPrerequisite [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-CbrPrerequisite` cmdlet verifies the prerequisites for Cloud-Based Ransomware Recovery for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Test-CbrPrerequisite -jsonFile .\cbrDeploySpec.json
23 | ```
24 |
25 | This example verifies the prerequisites for Cloud-Based Ransomware Recovery.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbw/Invoke-CbwDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-CbwDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end deployment of Cloud-Based Workload Protection.
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-CbwDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-CbwDeployment` cmdlet is a single function to implement the configuration of the Cloud-Based Workload Protection for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-CbwDeployment -jsonFile .\cbwDeploySpec.json
23 | ```
24 |
25 | This example configures Cloud-Based Workload Protection for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbw/Invoke-CbwSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-CbwSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Cloud-Based Workload Protection.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-CbwSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-CbwSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Cloud-Based Workload Protection for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-CbwSolutionInterop -jsonFile .\cbwDeploySpec.json
25 | ```
26 |
27 | This example configures solution interoperability of the Cloud-Based Workload Protection for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbw/Invoke-UndoCbwDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoCbwDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end removal of Cloud-Based Workload Protection.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoCbwDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoCbwDeployment` cmdlet is a single function to removal the configuration of the Cloud-Based Workload Protection for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Invoke-UndoCbwDeployment -jsonFile .\cbwDeploySpec.json
23 | ```
24 |
25 | This example removes Cloud-Based Workload Protection for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbw/Invoke-UndoCbwSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoCbwSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Cloud-Based Workload Protection.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoCbwSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoCbwSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Cloud-Based Workload Protection for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-UndoCbwSolutionInterop -jsonFile .\cbwDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Cloud-Based Workload Protection for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/cbw/Test-CbwPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-CbwPrerequisite
2 |
3 | ## Synopsis
4 |
5 | Verify the prerequisites for Cloud-Based Workload Protection
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Test-CbwPrerequisite [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-CbwPrerequisite` cmdlet verifies the prerequisites for Cloud-Based Workload Protection for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Test-CbwPrerequisite -jsonFile .\cbwDeploySpec.json
23 | ```
24 |
25 | This example verifies the prerequisites for Cloud-Based Workload Protection.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ccm/Invoke-CcmDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-CcmDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end Deployment of Cross Cloud Mobility
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-CcmDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-CcmDeployment` cmdlet is a single function to implement the configuration of the Cross Cloud Mobility for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-CcmDeployment -jsonFile .\ccmDeploySpec.json
23 | ```
24 |
25 | This example configures Cross Cloud Mobility for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ccm/Invoke-CcmSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-CcmSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Cross Cloud Mobility.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-CcmSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-CcmSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Cross Cloud Mobility for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-CcmSolutionInterop -jsonFile .\ccmDeploySpec.json
25 | ```
26 |
27 | This example configures solution interoperability of the Cross Cloud Mobility for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ccm/Invoke-UndoCcmDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoCcmDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end removal of Cross Cloud Mobility
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-UndoCcmDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoCcmDeployment` cmdlet is a single function to removal the configuration of the Cross Cloud Mobility for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-UndoCcmDeployment -jsonFile .\ccmDeploySpec.json
23 | ```
24 |
25 | This example removes Cross Cloud Mobility for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ccm/Invoke-UndoCcmSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoCcmSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Cross Cloud Mobility.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoCcmSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The Invoke-UndoCcmSolutionInterop cmdlet is a single function to remove the solution interoperability of the Cross Cloud Mobility for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-UndoCcmSolutionInterop -jsonFile .\ccmDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Cross Cloud Mobility for VMware Cloud Foundation using the JSON spec supplied.
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ccm/Test-CcmPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-CcmPrerequisite
2 |
3 | ## Synopsis
4 | Verify the prerequisites for Cross Cloud Mobility
5 |
6 | ## Syntax
7 |
8 | ``` PowerShell
9 | Test-CcmPrerequisite [-jsonFile] []
10 | ```
11 |
12 | ## Description
13 |
14 | The `Test-CcmPrerequisite` cmdlet verifies the prerequisites for Cross Cloud Mobility for VMware Cloud Foundation validated solution.
15 |
16 | ## Examples
17 |
18 | ### Example 1
19 |
20 | ``` PowerShell
21 | Test-CcmPrerequisite -jsonFile .\cbwDeploySpec.json
22 | ```
23 |
24 | This example verifies the prerequisites for Cross Cloud Mobility.
25 |
26 | ## Parameters
27 |
28 | ### -jsonFile
29 |
30 | The path to the JSON specification file.
31 |
32 | ```yaml
33 | Type: String
34 | Parameter Sets: (All)
35 | Aliases:
36 |
37 | Required: True
38 | Position: 1
39 | Default value: None
40 | Accept pipeline input: False
41 | Accept wildcard characters: False
42 | ```
43 |
44 | ### Common Parameters
45 |
46 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
47 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/dri/Test-DriPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-DriPrerequisite
2 |
3 | ## Synopsis
4 |
5 | Verify the prerequisites for Developer Ready Infrastructure
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Test-DriPrerequisite [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-DriPrerequisite` cmdlet verifies the prerequisites for Developer Ready Infrastructure for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Test-DriPrerequisite -jsonFile .\dri DeploySpec.json
23 | ```
24 |
25 | This example verifies the prerequisites for Developer Ready Infrastructure.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/hrm/Invoke-UndoHrmDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoHrmDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end removal of Health Reporting and Monitoring.
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-UndoHrmDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoHrmDeployment` cmdlet is a single function to remove the configuration of the Health Reporting and Monitoring for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-UndoHrmDeployment -jsonFile .\hrmDeploySpec.json
23 | ```
24 |
25 | This example removes the configuration of Health Reporting and Monitoring for VMware Cloud Foundation using JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/iam/Test-IamPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-IamPrerequisite
2 |
3 | ## Synopsis
4 |
5 | Verify the prerequisites for Identity and Access Management
6 |
7 | ## Syntax
8 |
9 | ``` PowerShell
10 | Test-IamPrerequisite [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-IamPrerequisite` cmdlet verifies the prerequisites for Identity and Access Management for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` PowerShell
22 | Test-IamPrerequisite -jsonFile .\iamDeploySpec.json
23 | ```
24 |
25 | This example verifies the prerequisites for Identity and Access Management.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ila/Invoke-IlaSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-IlaSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Intelligent Logging and Analytics.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-IlaSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-IlaSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Intelligent Logging and Analytics for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-IlaSolutionInterop -jsonFile .\ilaDeploySpec.json
25 | This example configures solution interoperability of the Intelligent Logging and Analytics for VMware Cloud Foundation using the JSON spec supplied
26 | ```
27 |
28 | ## Parameters
29 |
30 | ### -jsonFile
31 |
32 | The JSON (.json) file created.
33 |
34 | ```yaml
35 | Type: String
36 | Parameter Sets: (All)
37 | Aliases:
38 |
39 | Required: True
40 | Position: 1
41 | Default value: None
42 | Accept pipeline input: False
43 | Accept wildcard characters: False
44 | ```
45 |
46 | ### Common Parameters
47 |
48 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
49 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/ila/Invoke-UndoIlaSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoIlaSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Intelligent Logging and Analytics.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoIlaSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoIlaSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Intelligent Logging and Analytics for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-UndoIlaSolutionInterop -jsonFile .\ilaDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Intelligent Logging and Analytics for VMware Cloud Foundation using the JSON spec supplied.
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/inv/Invoke-InvSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-InvSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Intelligent Network Visibility.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-InvSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-InvSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Intelligent Network Visibility for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-InvSolutionInterop -jsonFile .\invDeploySpec.json
25 | ```
26 |
27 | This example configures solution interoperability of the Intelligent Network Visibility for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/inv/Invoke-UndoInvDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoInvDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end removal of Intelligent Network Visibility.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoInvDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoInvDeployment` cmdlet is a single function to remove the configuration of the Intelligent Network Visibility for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Invoke-UndoInvDeployment -jsonFile .\invDeploySpec.json
23 | ```
24 |
25 | This example removes the configuration of Intelligent Network Visibility for VMware Cloud Foundation using the JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON specification file for the Intelligent Network Visibility for VMware Cloud Foundation validated solution.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/inv/Invoke-UndoInvSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoInvSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Intelligent Network Visibility.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoInvSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoInvSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Intelligent Network Visibility for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-UndoInvSolutionInterop -jsonFile .\invDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Intelligent Network Visibility for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/iom/Invoke-IomSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-IomSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Intelligent Operations Management.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-IomSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-IomSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Intelligent Operations Management for VMware Cloud Foundation validated solution for:
16 |
17 | - Logging
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershel
24 | Invoke-IomSolutionInterop -jsonFile .\iomDeploySpec.json
25 | ```
26 |
27 | This example configures solution interoperability of the Intelligent Operations Management for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/iom/Invoke-UndoIomSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoIomSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Intelligent Operations Management.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoIomSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoIomSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Intelligent Operations Management for VMware Cloud Foundation validated solution for:
16 |
17 | - Logging
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ``` powershell
24 | Invoke-UndoIomSolutionInterop -jsonFile .\iomDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Intelligent Operations Management for VMware Cloud Foundation using the JSON spec supplied
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/lcm/Invoke-VrslcmUndoDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-VrslcmUndoDeployment
2 |
3 | ## Synopsis
4 |
5 | Remove VMware Aria Suite Lifecycle.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-VrslcmUndoDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-VrslcmUndoDeployment` cmdlet is a single function to remove VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Invoke-VrslcmUndoDeployment -jsonFile .\vrslcmDeploySpec.json
23 | ```
24 |
25 | This example removes VMware Aria Suite Lifecycle.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file to be used.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/lcm/Test-VrslcmPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-VrslcmPrerequisite
2 |
3 | ## Synopsis
4 |
5 | Verify the prerequisites for VMware Aria Suite Lifecycle.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Test-VrslcmPrerequisite [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-VrslcmPrerequisite` cmdlet verifies the prerequisites for VMware Aria Suite Lifecycle.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Test-VrslcmPrerequisite -jsonFile .\vrslcmDeploySpec.json
23 | ```
24 |
25 | This example verifies the prerequisites for VMware Aria Suite Lifecycle.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/pca/Invoke-PcaSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-PcaSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Private Cloud Automation.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-PcaSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-PcaSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Private Cloud Automation for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 | - Logging
19 |
20 | ## Examples
21 |
22 | ### Example 1
23 |
24 | ```powershell
25 | Invoke-PcaSolutionInterop -jsonFile .\pcaDeploySpec.json
26 | ```
27 |
28 | This example configures solution interoperability of the Private Cloud Automation for VMware Cloud Foundation using the JSON spec supplied
29 |
30 | ## Parameters
31 |
32 | ### -jsonFile
33 |
34 | The JSON (.json) file created.
35 |
36 | ```yaml
37 | Type: String
38 | Parameter Sets: (All)
39 | Aliases:
40 |
41 | Required: True
42 | Position: 1
43 | Default value: None
44 | Accept pipeline input: False
45 | Accept wildcard characters: False
46 | ```
47 |
48 | ### Common Parameters
49 |
50 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
51 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/pca/Invoke-UndoPcaSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoPcaSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Private Cloud Automation.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoPcaSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoPcaSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Private Cloud Automation for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 |
19 | ## Examples
20 |
21 | ### Example 1
22 |
23 | ```powershell
24 | Invoke-UndoPcaSolutionInterop -jsonFile .\pcaDeploySpec.json
25 | ```
26 |
27 | This example removes solution interoperability of the Private Cloud Automation for VMware Cloud Foundation using the JSON spec supplied.
28 |
29 | ## Parameters
30 |
31 | ### -jsonFile
32 |
33 | The JSON (.json) file created.
34 |
35 | ```yaml
36 | Type: String
37 | Parameter Sets: (All)
38 | Aliases:
39 |
40 | Required: True
41 | Position: 1
42 | Default value: None
43 | Accept pipeline input: False
44 | Accept wildcard characters: False
45 | ```
46 |
47 | ### Common Parameters
48 |
49 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/pdr/Invoke-PdrSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-PdrSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Configure solution interoperability for Site Protection and Disaster Recovery.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-PdrSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-PdrSolutionInterop` cmdlet is a single function to configure the solution interoperability of the Site Protection and Disaster Recovery for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 | - Logging
19 |
20 | ## Examples
21 |
22 | ### Example 1
23 |
24 | ```powershell
25 | Invoke-PdrSolutionInterop -jsonFile .\pdrDeploySpec.json
26 | ```
27 |
28 | This example configures solution interoperability of the Site Protection and Disaster Recovery for VMware Cloud Foundation using the JSON spec supplied
29 |
30 | ## Parameters
31 |
32 | ### -jsonFile
33 |
34 | The JSON (.json) file created.
35 |
36 | ```yaml
37 | Type: String
38 | Parameter Sets: (All)
39 | Aliases:
40 |
41 | Required: True
42 | Position: 1
43 | Default value: None
44 | Accept pipeline input: False
45 | Accept wildcard characters: False
46 | ```
47 |
48 | ### Common Parameters
49 |
50 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
51 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/pdr/Invoke-UndoPdrDeployment.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoPdrDeployment
2 |
3 | ## Synopsis
4 |
5 | End-to-end removal of Site Protection and Disaster Recovery.
6 |
7 | ## Syntax
8 |
9 | ``` powershell
10 | Invoke-UndoPdrDeployment [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoPdrDeployment` cmdlet is a single function to remove the configuration of the Site Protection and Disaster Recovery for VMware Cloud Foundation validated solution.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ``` powershell
22 | Invoke-UndoPdrDeployment -jsonFile .\pdrDeploySpec.json
23 | ```
24 |
25 | This example removes the configuration of Site Protection and Disaster Recovery for VMware Cloud Foundation using JSON spec supplied.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The JSON (.json) file created.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/pdr/Invoke-UndoPdrSolutionInterop.md:
--------------------------------------------------------------------------------
1 | # Invoke-UndoPdrSolutionInterop
2 |
3 | ## Synopsis
4 |
5 | Remove solution interoperability for Site Protection and Disaster Recovery.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Invoke-UndoPdrSolutionInterop [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Invoke-UndoPcaSolutionInterop` cmdlet is a single function to remove the solution interoperability of the Site Protection and Disaster Recovery for VMware Cloud Foundation validated solution for:
16 |
17 | - Monitoring and Alerting
18 | - Logging
19 |
20 | ## Examples
21 |
22 | ### Example 1
23 |
24 | ```powershell
25 | Invoke-UndoPcaSolutionInterop -jsonFile .\pdrDeploySpec.json
26 | ```
27 |
28 | This example removes solution interoperability of the Site Protection and Disaster Recovery for VMware Cloud Foundation using the JSON spec supplied.
29 |
30 | ## Parameters
31 |
32 | ### -jsonFile
33 |
34 | The JSON (.json) file created.
35 |
36 | ```yaml
37 | Type: String
38 | Parameter Sets: (All)
39 | Aliases:
40 |
41 | Required: True
42 | Position: 1
43 | Default value: None
44 | Accept pipeline input: False
45 | Accept wildcard characters: False
46 | ```
47 |
48 | ### Common Parameters
49 |
50 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
51 |
--------------------------------------------------------------------------------
/docs/documentation/functions/solutions/wsa/Test-GlobalWsaPrerequisite.md:
--------------------------------------------------------------------------------
1 | # Test-GlobalWsaPrerequisite
2 |
3 | ## SYNOPSIS
4 |
5 | Verify the prerequisites for Global Workspace ONE Access.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Test-GlobalWsaPrerequisite [-jsonFile] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Test-GlobalWsaPrerequisite` cmdlet verifies the prerequisites for Global Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```pwoershell
22 | Test-GlobalWsaPrerequisite -jsonFile .\wsaDeploySpec.json
23 | ```
24 |
25 | This example verifies the prerequisites for Global Workspace ONE Access.
26 |
27 | ## Parameters
28 |
29 | ### -jsonFile
30 |
31 | The path to the JSON specification file.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### Common Parameters
46 |
47 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
48 |
--------------------------------------------------------------------------------
/docs/documentation/functions/supporting/Test-PowerValidatedSolutionsPrereq.md:
--------------------------------------------------------------------------------
1 | # Test-PowerValidatedSolutionsPrereq
2 |
3 | ## Synopsis
4 |
5 | Validate prerequisites to run the PowerShell module.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Test-PowerValidatedSolutionsPrereq
11 | ```
12 |
13 | ## Description
14 |
15 | The Test-PowerValidatedSolutionsPrereq cmdlet checks that all the prerequisites have been met to run the PowerShell module.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Test-PowerValidatedSolutionsPrereq
23 | ```
24 |
25 | This example runs the prerequisite validation.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-replication/Get-VrmsApplianceDetail.md:
--------------------------------------------------------------------------------
1 | # Get-VrmsApplianceDetail
2 |
3 | ## Synopsis
4 |
5 | Get information about the vSphere Replication appliance.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VrmsApplianceDetail
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VrmsApplianceDetail` cmdlet retrieves information about the vSphere Replication appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VrmsApplianceDetail
23 | ```
24 |
25 | This example retrieves information about the vSphere Replication appliance
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-replication/Get-VrmsNetworkAll.md:
--------------------------------------------------------------------------------
1 | # Get-VrmsNetworkAll
2 |
3 | ## Synopsis
4 |
5 | Get all network configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VrmsNetworkAll
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VrmsNetworkAll` cmdlet retrieves all the network configuration of a vSphere Replication appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VrmsNetworkAll
23 | ```
24 |
25 | This example retrieves all network configuration of the vSphere Replication appliance
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-replication/Get-VrmsNetworkDns.md:
--------------------------------------------------------------------------------
1 | # Get-VrmsNetworkDns
2 |
3 | ## Synopsis
4 |
5 | Get DNS configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VrmsNetworkDns
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VrmsNetworkDns` cmdlet retrieves DNS configuration of a vSphere Replication appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VrmsNetworkDns
23 | ```
24 |
25 | This example retrieves information about the DNS configuration of the vSphere Replication appliance
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-replication/Get-VrmsNetworkInterface.md:
--------------------------------------------------------------------------------
1 | # Get-VrmsNetworkInterface
2 |
3 | ## Synopsis
4 |
5 | Get network interface configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VrmsNetworkInterface
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VrmsNetworkInterface` cmdlet retrieves network interface configuration of a vSphere Replication appliance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VrmsNetworkInterface
23 | ```
24 |
25 | This example retrieves information about the network interface configuration of the vSphere Replication appliance
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-replication/Get-VrmsSitePairing.md:
--------------------------------------------------------------------------------
1 | # Get-VrmsSitePairing
2 |
3 | ## Synopsis
4 |
5 | Retrieve site pairing information from a vSphere Replication instance.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VrmsSitePairing
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VrmsSitePairing` cmdlet retrieves site pairing information from a vSphere Replication instance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VrmsSitePairing
23 | ```
24 |
25 | This example retrieves site pairings from the vSphere Replication instance.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-tanzu/Disconnect-WMCluster.md:
--------------------------------------------------------------------------------
1 | # Disconnect-WMCluster
2 |
3 | ## Synopsis
4 |
5 | Disconnect from o the Supervisor Cluster
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Disconnect-WMCluster
11 | ```
12 |
13 | ## Description
14 |
15 | The `Disconnect-WMCluster` cmdlet disconnects from the Supervisor Cluster.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Disconnect-WMCluster
23 | ```
24 |
25 | This example disconnects from the Supervisor Cluster
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere-tanzu/Get-WMLicenseStatus.md:
--------------------------------------------------------------------------------
1 | # Get-WMLicenseStatus
2 |
3 | ## Synopsis
4 |
5 | Get Workload Management license status
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WMLicenseStatus
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WMLicenseStatus` cmdlet gets the license status from vCenter Server for Workload Management.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WMLicenseStatus
23 | ```
24 |
25 | This example gets the vSphere with Tanzu licenses status from vCenter Server for Workload Management
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Disconnect-vSphereMobServer.md:
--------------------------------------------------------------------------------
1 | # Disconnect-vSphereMobServer
2 |
3 | ## Synopsis
4 |
5 | Disconnects from the vSphere Managed Object Browser (MOB)
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Disconnect-vSphereMobServer
11 | ```
12 |
13 | ## Description
14 |
15 | The `Disconnect-vSphereMobServer` cmdlet is used to disconnect from the vSphere Managed Object Browser (MOB).
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Disconnect-vSphereMobServer
23 | ```
24 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-GlobalPermission.md:
--------------------------------------------------------------------------------
1 | # Get-GlobalPermission
2 |
3 | ## Synopsis
4 |
5 | Get vSphere Global Permission
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-GlobalPermission
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-GlobalPermission` cmdlet gets a list of vSphere Global Permission.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-GlobalPermission
23 | ```
24 |
25 | This example shows how to gets a list of vSphere Global Permission
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VCConfigurationDNS.md:
--------------------------------------------------------------------------------
1 | # Get-VCConfigurationDNS
2 |
3 | ## Synopsis
4 |
5 | Get DNS configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VCConfigurationDNS
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VCConfigurationDNS` cmdlet gets the DNS configuration of vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VCConfigurationDNS
23 | ```
24 |
25 | This example gets the DNS configuration of the vCenter Server
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VCConfigurationNTP.md:
--------------------------------------------------------------------------------
1 | # Get-VCConfigurationNTP
2 |
3 | ## Synopsis
4 |
5 | Get NTP configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VCConfigurationNTP
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VCConfigurationNTP` cmdlet gets the NTP configuration of vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VCConfigurationNTP
23 | ```
24 |
25 | This example gets the NTP configuration of the vCenter Server
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VCVersion.md:
--------------------------------------------------------------------------------
1 | # Get-VcVersion
2 |
3 | ## Synopsis
4 |
5 | Get the vCenter Server version
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VcVersion
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VcVersion` cmdlet gets the version of the vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VcVersion
23 | ```
24 |
25 | This example gets the version of the vCenter Server
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VCenterCEIP.md:
--------------------------------------------------------------------------------
1 | # Get-VcenterCEIP
2 |
3 | ## Synopsis
4 |
5 | Retrieves the the Customer Experience Improvement Program (CEIP) setting for vCenter Server
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VcenterCEIP
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VcenterCEIP` cmdlet retrieves the the CEIP setting for vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VcenterCEIP
23 | ```
24 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VMvAppConfig.md:
--------------------------------------------------------------------------------
1 | # Get-VMvAppConfig
2 |
3 | ## Synopsis
4 |
5 | Retrieves the full OVF environment settings from a standard VM.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VMvAppConfig [-vm] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | Saves the setting of the passed VM object to a JSON file.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VMAppConfig -vm $vm
23 | ```
24 |
25 | ## Parameters
26 |
27 | ### -vm
28 |
29 | The virtual appliance to retrieve the OVF properties from.
30 |
31 | ```yaml
32 | Type: PSObject
33 | Parameter Sets: (All)
34 | Aliases:
35 |
36 | Required: True
37 | Position: 1
38 | Default value: None
39 | Accept pipeline input: False
40 | Accept wildcard characters: False
41 | ```
42 |
43 | ### -ProgressAction
44 |
45 | Progress Action
46 |
47 | ```yaml
48 | Type: ActionPreference
49 | Parameter Sets: (All)
50 | Aliases: proga
51 |
52 | Required: False
53 | Position: Named
54 | Default value: None
55 | Accept pipeline input: False
56 | Accept wildcard characters: False
57 | ```
58 |
59 | ### Common Parameters
60 |
61 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
62 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VcLicense.md:
--------------------------------------------------------------------------------
1 | # Get-VcLicense
2 |
3 | ## Synopsis
4 |
5 | Get list of licenses in vCenter Server
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VcLicense
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VcLicense` cmdlet gets a list of licenses in vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VcLicense
23 | ```
24 |
25 | This example shows how to get a list of licenses in vCenter Server
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VcenterBackupStatus.md:
--------------------------------------------------------------------------------
1 | # Get-VcenterBackupStatus
2 |
3 | ## Synopsis
4 |
5 | Returns a list of all backup jobs performed on a vCenter Server instance.
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VcenterBackupStatus
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VcenterBackupStatus` cmdlet returns a list of all backups performed on a vCenter Server instance.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VcenterBackupStatus | Select-Object -Last 1
23 | ```
24 |
25 | This example demonstrates piping the results of this function into Select-Object to return the status of the last backup.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VcenterPasswordExpiration.md:
--------------------------------------------------------------------------------
1 | # Get-VcenterPasswordExpiration
2 |
3 | ## Synopsis
4 |
5 | Retrieve the global password expiration policy
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VcenterPasswordExpiration
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VcenterPasswordExpiration` cmdlet retrieves the global password expiration policy for local users of vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VcenterPasswordExpiration
23 | ```
24 |
25 | This example retrieves the global password expiration policy of the vCenter Server
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Get-VcenterRootPasswordExpiration.md:
--------------------------------------------------------------------------------
1 | # Get-VcenterRootPasswordExpiration
2 |
3 | ## Synopsis
4 |
5 | Retrieve the root user password expiration policy
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-VcenterRootPasswordExpiration
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-VcenterRootPasswordExpiration` cmdlet retrieves the root user password expiration policy from vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-VcenterRootPasswordExpiration
23 | ```
24 |
25 | This example retrieves the root user password expiration policy from vCenter Server
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/New-VcLicense.md:
--------------------------------------------------------------------------------
1 | # New-VcLicense
2 |
3 | ## Synopsis
4 |
5 | Add a license to vCenter Server
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | New-VcLicense [-licenseKey] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `New-VcLicense` cmdlet adds a license to vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | New-VcLicense [-licenseKey]
23 | ```
24 |
25 | This example shows how to add a license to vCenter Server.
26 |
27 | ## Parameters
28 |
29 | ### -licenseKey
30 |
31 | The license key.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/vsphere/Remove-VcLicense.md:
--------------------------------------------------------------------------------
1 | # Remove-VcLicense
2 |
3 | ## Synopsis
4 |
5 | Remove a license from vCenter Server
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Remove-VcLicense [-licenseKey] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Remove-VcLicense` cmdlet removes a license from vCenter Server.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Remove-VcLicense -licenseKey
23 | ```
24 |
25 | This example shows how to remove a license from vCenter Server.
26 |
27 | ## Parameters
28 |
29 | ### -licenseKey
30 |
31 | The license key.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSAClient.md:
--------------------------------------------------------------------------------
1 | # Get-WSAClient
2 |
3 | ## Synopsis
4 |
5 | Get clients
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSAClient [[-clientId] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSAClient` cmdlets gets a list of clients in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSAClient
23 | ```
24 |
25 | This example retrieves all clients in Workspace ONE Access.
26 |
27 | ## Parameters
28 |
29 | ### -clientId
30 |
31 | The client ID.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSAConnector.md:
--------------------------------------------------------------------------------
1 | # Get-WSAConnector
2 |
3 | ## Synopsis
4 |
5 | Get connectors
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSAConnector
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSAConnector` cmdlets retrieves a list of connectors in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSAConnector
23 | ```
24 |
25 | This example retrieves a list of connectors in Workspace ONE Access
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSAGroup.md:
--------------------------------------------------------------------------------
1 | # Get-WSAGroup
2 |
3 | ## Synopsis
4 |
5 | Get groups
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSAGroup [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSAGroup` cmdlets retrieves the groups in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSAGroup
23 | ```
24 |
25 | This example retrieves the groups in Workspace ONE Access.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The Group ID.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSAIdentityProvider.md:
--------------------------------------------------------------------------------
1 | # Get-WSAIdentityProvider
2 |
3 | ## Synopsis
4 |
5 | Get identity providers
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSAIdentityProvider
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSAIdentityProvider` cmdlets retrieves a list of identity providers in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSAIdentityProvider
23 | ```
24 |
25 | This example retrieves a list of identity providers in Workspace ONE Access
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSAOAuthToken.md:
--------------------------------------------------------------------------------
1 | # Get-WSAOAuthToken
2 |
3 | ## Synopsis
4 |
5 | Get AOuth Token
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSAOAuthToken
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSAOAuthToken` cmdlets gets an OAuth token from Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSAOAuthToken
23 | ```
24 |
25 | This example retrieves the am OAuth token from Workspace ONE Access
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSARole.md:
--------------------------------------------------------------------------------
1 | # Get-WSARole
2 |
3 | ## Synopsis
4 |
5 | Get roles
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSARole [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSARole` cmdlets retrieves the roles in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSARole
23 | ```
24 |
25 | This example retrieves the roles in Workspace ONE Access.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The Role ID.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSARoleId.md:
--------------------------------------------------------------------------------
1 | # Get-WSARoleId
2 |
3 | ## Synopsis
4 |
5 | Get role id for role name
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSARoleId [-role] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSARoleId` cmdlet get the role id corresponding to the given role name.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSARoleId -role "Super Admin"
23 | ```
24 |
25 | This retrieves the id for the Super Admin role.
26 |
27 | ## Parameters
28 |
29 | ### -role
30 |
31 | The role name.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: True
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSARuleSet.md:
--------------------------------------------------------------------------------
1 | # Get-WSARuleSet
2 |
3 | ## Synopsis
4 |
5 | Get rulesets
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSARuleSet
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSARuleSet` cmdlets retrieves the rulesets in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSARuleSet
23 | ```
24 |
25 | This example retrieves the rulesets in Workspace ONE Access
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSASmtpConfiguration.md:
--------------------------------------------------------------------------------
1 | # Get-WSASmtpConfiguration
2 |
3 | ## Synopsis
4 |
5 | Get SMTP configuration
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSASmtpConfiguration
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSASmtpConfiguration` cmdlets retrieves the SMTP configurtion of Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSASmtpConfiguration
23 | ```
24 |
25 | This example gets the current SMTP configuration of Workspace ONE Access.
26 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WSAUser.md:
--------------------------------------------------------------------------------
1 | # Get-WSAUser
2 |
3 | ## Synopsis
4 |
5 | Get users
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WSAUser [[-id] ] [-ProgressAction ] []
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WSAUser` cmdlets retrieves the users in Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WSAUser
23 | ```
24 |
25 | This example retrieves the users in Workspace ONE Access.
26 |
27 | ## Parameters
28 |
29 | ### -id
30 |
31 | The User ID.
32 |
33 | ```yaml
34 | Type: String
35 | Parameter Sets: (All)
36 | Aliases:
37 |
38 | Required: False
39 | Position: 1
40 | Default value: None
41 | Accept pipeline input: False
42 | Accept wildcard characters: False
43 | ```
44 |
45 | ### -ProgressAction
46 |
47 | Progress Action
48 |
49 | ```yaml
50 | Type: ActionPreference
51 | Parameter Sets: (All)
52 | Aliases: proga
53 |
54 | Required: False
55 | Position: Named
56 | Default value: None
57 | Accept pipeline input: False
58 | Accept wildcard characters: False
59 | ```
60 |
61 | ### Common Parameters
62 |
63 | This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
64 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WsaAccountLockout.md:
--------------------------------------------------------------------------------
1 | # Get-WsaAccountLockout
2 |
3 | ## Synopsis
4 |
5 | Get account lockout policy
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WsaAccountLockout
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WsaAccountLockout` cmdlet get details of the account lockout policy for Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WsaAccountLockout
23 | ```
24 |
--------------------------------------------------------------------------------
/docs/documentation/functions/workspace-one-access/Get-WsaPasswordPolicy.md:
--------------------------------------------------------------------------------
1 | # Get-WsaPasswordPolicy
2 |
3 | ## Synopsis
4 |
5 | Get password policy
6 |
7 | ## Syntax
8 |
9 | ```powershell
10 | Get-WsaPasswordPolicy
11 | ```
12 |
13 | ## Description
14 |
15 | The `Get-WsaPasswordPolicy` cmdlet get details of the password policy for Workspace ONE Access.
16 |
17 | ## Examples
18 |
19 | ### Example 1
20 |
21 | ```powershell
22 | Get-WsaPasswordPolicy
23 | ```
24 |
--------------------------------------------------------------------------------
/docs/documentation/index.md:
--------------------------------------------------------------------------------
1 | # Reference
2 |
3 | ## Using the Module
4 |
5 | Navigate the reference for this PowerShell module to view how to use each available cmdlet based on the topic area.
6 |
--------------------------------------------------------------------------------
/docs/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/docs/favicon.ico
--------------------------------------------------------------------------------
/docs/license.md:
--------------------------------------------------------------------------------
1 | --8<-- "./LICENSE"
2 |
--------------------------------------------------------------------------------
/docs/release-notes.md:
--------------------------------------------------------------------------------
1 | --8<-- "./CHANGELOG.md"
2 |
--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | mkdocs-git-revision-date-localized-plugin>=1.2.6
2 | mkdocs-markdownextradata-plugin>=0.2.5
3 | mkdocs-minify-plugin>=0.7.1
4 | mkdocs-open-in-new-tab>=1.0.3
5 |
--------------------------------------------------------------------------------
/docs/snippets/copy-module-local-linux.sh:
--------------------------------------------------------------------------------
1 | scp -r /home/modules/* username@remote_host:/home/lab/.local/share/powershell/Modules/
--------------------------------------------------------------------------------
/docs/snippets/copy-module-local-windows.ps1:
--------------------------------------------------------------------------------
1 | Copy-Item -Path F:\Modules\* -Destination '\\\C$\Program Files\WindowsPowerShell\Modules\' -Recurse
2 |
--------------------------------------------------------------------------------
/docs/snippets/import-module-local-linux.ps1:
--------------------------------------------------------------------------------
1 | Import-Module -Name VMware.PowerCLI
2 | Import-Module -Name VMware.vSphere.SsoAdmin
3 | Import-Module -Name PowerVCF
4 | Import-Module -Name PowerValidatedSolutions
5 | Import-Module -Name ImportExcel
--------------------------------------------------------------------------------
/docs/snippets/import-module.ps1:
--------------------------------------------------------------------------------
1 | Import-Module -Name VMware.PowerCLI
2 | Import-Module -Name VMware.vSphere.SsoAdmin
3 | Import-Module -Name PowerVCF
4 | Import-Module -Name PowerValidatedSolutions
5 | Import-Module -Name ImportExcel
6 |
--------------------------------------------------------------------------------
/docs/snippets/install-module.ps1:
--------------------------------------------------------------------------------
1 | Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
2 | Install-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Repository PSGallery -Scope AllUsers
3 | Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Repository PSGallery -Scope AllUsers
4 | Install-Module -Name PowerVCF -MinimumVersion 2.4.1 -Repository PSGallery -Scope AllUsers
5 | Install-Module -Name ImportExcel -MinimumVersion 7.8.9 -Repository PSGallery -Scope AllUsers
6 | Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.2 -Repository PSGallery -Scope AllUsers
7 |
--------------------------------------------------------------------------------
/docs/snippets/installed-module.ps1:
--------------------------------------------------------------------------------
1 | Get-InstalledModule -Name PowerValidatedSolutions
2 |
--------------------------------------------------------------------------------
/docs/snippets/pre-req-linux.sh:
--------------------------------------------------------------------------------
1 | mkdir /home/modules
--------------------------------------------------------------------------------
/docs/snippets/save-module-local-linux.ps1:
--------------------------------------------------------------------------------
1 | Save-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Path /home/modules -Repository PSGallery
2 | Save-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Path /home/modules -Repository PSGallery
3 | Save-Module -Name PowerVCF -MinimumVersion 2.4.1 -Path /home/modules -Repository PSGallery
4 | Save-Module -Name ImportExcel -MinimumVersion 7.8.9 -Path /home/modules -Repository PSGallery
5 | Save-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.3 -Path /home/modules -Repository PSGallery
6 |
--------------------------------------------------------------------------------
/docs/snippets/save-module-local-windows.ps1:
--------------------------------------------------------------------------------
1 | Save-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Path F:\Modules\ -Repository PSGallery
2 | Save-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Path F:\Modules\ -Repository PSGallery
3 | Save-Module -Name PowerVCF -MinimumVersion 2.4.1 -Path F:\Modules\ -Repository PSGallery
4 | Save-Module -Name ImportExcel -MinimumVersion 7.8.9 -Path F:\Modules\ -Repository PSGallery
5 | Save-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.2 -Path F:\Modules\ -Repository PSGallery
6 |
--------------------------------------------------------------------------------
/docs/snippets/update-module.ps1:
--------------------------------------------------------------------------------
1 | Update-Module -Name PowerValidatedSolutions
2 |
--------------------------------------------------------------------------------
/docs/snippets/update-modules.ps1:
--------------------------------------------------------------------------------
1 | Update-Module -Name VMware.PowerCLI
2 | Update-Module -Name VMware.vSphere.SsoAdmin
3 | Update-Module -Name PowerVCF
4 | Update-Module -Name ImportExcel
5 |
--------------------------------------------------------------------------------
/docs/update.md:
--------------------------------------------------------------------------------
1 | # Updating the Module
2 |
3 | Update the PowerShell module from the PowerShell Gallery by running the following commands:
4 |
5 | ```powershell
6 | --8<-- "./docs/snippets/update-module.ps1"
7 | ```
8 |
9 | To verify that the PowerShell module is updated, run the following command in the PowerShell console.
10 |
11 | ```powershell
12 | --8<-- "./docs/snippets/installed-module.ps1"
13 | ```
14 |
15 | To verify the [module dependencies](index.md#module-dependencies) meet the minimum requirements, use the `Test-PowerValidatedSolutionsPrereq` cmdlet.
16 |
17 | If a dependency does not meet the minimum requirements, run the appropriate `Update-Module` command for the dependency in the PowerShell console.
18 |
19 | ```powershell
20 | --8<-- "./docs/snippets/update-modules.ps1"
21 | ```
22 |
--------------------------------------------------------------------------------
/docs/user-access.md:
--------------------------------------------------------------------------------
1 | # User Access
2 |
3 | Each cmdlet may provide one or more usage examples. Many of the cmdlets require that credentials are provided to output to the PowerShell console or a report.
4 |
5 | The cmdlets in this module, and its dependencies, return data from multiple platform components. The credentials for most of the platform components are returned to the cmdlets by retrieving credentials from the SDDC Manager inventory and using these credentials, as needed, within cmdlet operations.
6 |
7 | For the best experience, for cmdlets that connect to SDDC Manager, use the VMware Cloud Foundation API user `admin@local` or an account with the **ADMIN** role in SDDC Manager (e.g., `administrator@vsphere.local`).
8 |
--------------------------------------------------------------------------------
/vSphereRoles/aria-automation-assembler-vsphere-integration.role:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/vSphereRoles/aria-automation-assembler-vsphere-integration.role
--------------------------------------------------------------------------------
/vSphereRoles/aria-operations-for-logs-vsphere-integration.role:
--------------------------------------------------------------------------------
1 | Host.Config.AdvancedConfig
2 | Host.Config.NetService
3 | Host.Config.Network
4 | Host.Config.Settings
5 | System.Anonymous
6 | System.Read
7 | System.View
--------------------------------------------------------------------------------
/vSphereRoles/aria-operations-for-networks-vsphere-integration.role:
--------------------------------------------------------------------------------
1 | DVPortgroup.Modify
2 | DVPortgroup.PolicyOp
3 | DVSwitch.Modify
4 | DVSwitch.PortConfig
5 | Global.Settings
6 | System.Anonymous
7 | System.Read
8 | System.View
--------------------------------------------------------------------------------
/vSphereRoles/aria-operations-vsphere-integration-actions.role:
--------------------------------------------------------------------------------
1 | Datastore.Browse
2 | Datastore.AllocateSpace
3 | ExternalStatsProvider.Register
4 | ExternalStatsProvider.Update
5 | ExternalStatsProvider.Unregister
6 | Global.ManageCustomFields
7 | Global.SetCustomField
8 | Global.Health
9 | Global.SystemTag
10 | Global.GlobalTag
11 | Host.Inventory.EditCluster
12 | Performance.ModifyIntervals
13 | Resource.AssignVMToPool
14 | Resource.HotMigrate
15 | Resource.ColdMigrate
16 | System.Anonymous
17 | System.View
18 | System.Read
19 | StorageViews.View
20 | StorageProfile.View
21 | VirtualMachine.Inventory.Delete
22 | VirtualMachine.Interact.PowerOn
23 | VirtualMachine.Interact.PowerOff
24 | VirtualMachine.GuestOperations.Query
25 | VirtualMachine.GuestOperations.Modify
26 | VirtualMachine.GuestOperations.Execute
27 | VirtualMachine.GuestOperations.QueryAliases
28 | VirtualMachine.GuestOperations.ModifyAliases
29 | VirtualMachine.Config.CPUCount
30 | VirtualMachine.Config.Memory
31 | VirtualMachine.Config.Resource
32 | VirtualMachine.State.CreateSnapshot
33 | VirtualMachine.State.RemoveSnapshot
--------------------------------------------------------------------------------
/vSphereRoles/aria-operations-vsphere-integration-metrics.role:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/vSphereRoles/aria-operations-vsphere-integration-metrics.role
--------------------------------------------------------------------------------
/vSphereRoles/aria-operations-vsphere-integration.role:
--------------------------------------------------------------------------------
1 | Datastore.AllocateSpace
2 | Datastore.Browse
3 | Extension.Register
4 | Extension.Unregister
5 | Extension.Update
6 | ExternalStatsProvider.Register
7 | ExternalStatsProvider.Unregister
8 | ExternalStatsProvider.Update
9 | Global.GlobalTag
10 | Global.Health
11 | Global.ManageCustomFields
12 | Global.SetCustomField
13 | Global.SystemTag
14 | Host.Inventory.EditCluster
15 | Performance.ModifyIntervals
16 | Resource.AssignVMToPool
17 | Resource.ColdMigrate
18 | Resource.HotMigrate
19 | StorageProfile.View
20 | StorageViews.View
21 | System.Anonymous
22 | System.Read
23 | System.View
24 | VirtualMachine.Config.CPUCount
25 | VirtualMachine.Config.Memory
26 | VirtualMachine.Config.Resource
27 | VirtualMachine.GuestOperations.Execute
28 | VirtualMachine.GuestOperations.Modify
29 | VirtualMachine.GuestOperations.ModifyAliases
30 | VirtualMachine.GuestOperations.Query
31 | VirtualMachine.GuestOperations.QueryAliases
32 | VirtualMachine.Interact.PowerOff
33 | VirtualMachine.Interact.PowerOn
34 | VirtualMachine.Interact.Reset
35 | VirtualMachine.Inventory.Delete
36 | VirtualMachine.Inventory.Move
37 | VirtualMachine.Namespace.Management
38 | VirtualMachine.Namespace.ModifyContent
39 | VirtualMachine.Namespace.Query
40 | VirtualMachine.Namespace.ReadContent
41 | VirtualMachine.State.CreateSnapshot
42 | VirtualMachine.State.RemoveSnapshot
43 | vStats.CollectAny
44 | vStats.QueryAny
45 | vStats.Settings
--------------------------------------------------------------------------------
/vSphereRoles/aria-suite-lifecycle-vsphere-integration.role:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/vSphereRoles/aria-suite-lifecycle-vsphere-integration.role
--------------------------------------------------------------------------------
/vSphereRoles/nsx-vsphere-integration.role:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/vSphereRoles/nsx-vsphere-integration.role
--------------------------------------------------------------------------------
/vSphereRoles/vlcr-vsphere-integration.role:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vmware/power-validated-solutions-for-cloud-foundation/e5797c8c1fe44254774fbbb8315c1ae9f5ac18f3/vSphereRoles/vlcr-vsphere-integration.role
--------------------------------------------------------------------------------