feat: add pca solution interop (#652)

- Added `Invoke-PcaSolutionInterop` cmdlet to perform solution interoperability configuration for Private Cloud Automation. - Added `Invoke-UndoPcaSolutionInterop` cmdlet to perform the removal of solution interoperability configuration for Private Cloud Automation. - Fixed `Get-vRAIntegrationDetail` cmdlet where by it was passing output incorrectly. - Enhanced `New-vRAvROPSIntegrationItem` cmdlet for better error checking and message handling. - Enhanced `Undo-vRAvROPsIntegrationItem` cmdlet for better error checking and message handling. - Enhanced `Update-vROPSvRAAdapterCredential` cmdlet to reduce the number of inputs required. - Added Documentation Signed-off-by: Gary Blake <gblake@vmware.com>
vmware · Jun 10, 2024 · 2918801 · 2918801
1 parent f7ba07d
commit 2918801
Show file tree

Hide file tree

Showing 10 changed files with 462 additions and 125 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@
 - Added `Invoke-UndoIomSolutionInterop` cmdlet to perform the removal of solution interoperability configuration for Intelligent Operations Management.
 - Added `Invoke-InvSolutionInterop` cmdlet to perform solution interoperability configuration for Intelligent Network Visibility.
 - Added `Invoke-UndoInvSolutionInterop` cmdlet to perform the removal of solution interoperability configuration for Intelligent Network Visibility.
+- Added `Invoke-PcaSolutionInterop` cmdlet to perform solution interoperability configuration for Private Cloud Automation.
+- Added `Invoke-UndoPcaSolutionInterop` cmdlet to perform the removal of solution interoperability configuration for Private Cloud Automation.
 - Added `Invoke-CbwSolutionInterop` cmdlet to perform solution interoperability configuration for Cloud-Based Workload Protection.
 - Added `Invoke-UndoCbwSolutionInterop` cmdlet to perform the removal of solution interoperability configuration for Cloud-Based Workload Protection.
 - Added `Invoke-CbrSolutionInterop` cmdlet to perform solution interoperability configuration for Cloud-Based Ransomware Recovery.
@@ -22,13 +24,17 @@
 - Fixed `Invoke-IlaDeployment` cmdlet to configure NSX Syslog servers in the correct order after connecting VI Workload Domains.
 - Fixed `Request-IomMscaSignedCertificate` cmdlet where the data node FQDN for the SAN was not incorrect and the Cloud Proxy SANs were missing.
 - Fixed `Invoke-GlobalWsaDeployment` cmdlet to check for stretched cluster to be enabled and configure Anti-Affinity rule.
+- Fixed `Get-vRAIntegrationDetail` cmdlet where by it was passing output incorrectly.
 - Enhanced `config.PowerValidatedSolutions` configuration file to include VMware Cloud Foundation 5.2 support.
 - Enhanced `Install-vRSLCMCertificate` cmdlet to perform additional checks that a Microsoft Certificate Authority is configured in SDDC Manager.
 - Enhanced `Test-PrereqApplicationVirtualNetwork` cmdlet to allow validation of either X_REGION or REGION_A networks.
 - Enhanced `Export-vRLIJsonSpec` cmdlet for automatic placement of the VMware Aria Operations for Logs virtual appliances into the defined folder.
 - Enhanced `Export-vROPsJsonSpec` cmdlet for automatic placement of the VMware Aria Operations virtual appliances into the defined folder.
 - Enhanced `Export-InvJsonSpec` cmdlet for automatic placement of the VMware Aria Operations for Networks virtual appliances into the defined folder.
 - Enhanced `Export-vRAJsonSpec` cmdlet for automatic placement of the VMware Aria Automation virtual appliances into the defined folder.
+- Enhanced `New-vRAvROPSIntegrationItem` cmdlet for better error checking and message handling.
+- Enhanced `Undo-vRAvROPsIntegrationItem` cmdlet for better error checking and message handling.
+- Enhanced `Update-vROPSvRAAdapterCredential` cmdlet to reduce the number of inputs required.
 
 ## v2.10.0
 

diff --git a/PowerValidatedSolutions.psd1 b/PowerValidatedSolutions.psd1
@@ -11,7 +11,7 @@
     RootModule = 'PowerValidatedSolutions.psm1'
 
     # Version number of this module.
-    ModuleVersion = '2.11.0.1013'
+    ModuleVersion = '2.11.0.1014'
     # Supported PSEditions
     # CompatiblePSEditions = @()
 

diff --git a/PowerValidatedSolutions.psm1 b/PowerValidatedSolutions.psm1
diff --git a/...cumentation/functions/aria-suite/aria-automation/New-vRAvROPSIntegrationItem.md b/...cumentation/functions/aria-suite/aria-automation/New-vRAvROPSIntegrationItem.md
@@ -7,9 +7,7 @@ Creates new VMware Aria Operations integration in VMware Aria Automation
 ## Syntax
 
 ```powershell
-New-vRAvROPSIntegrationItem [-server] <String> [-user] <String> [-pass] <String> [-vraUser] <String>
- [-vraPass] <String> [-vropsIntegrationUser] <String> [-vropsIntegrationPass] <String>
- [-vropsIntegrationName] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+New-vRAvROPSIntegrationItem [-server] <String> [-user] <String> [-pass] <String> [-vraUser] <String> [-vraPass] <String> [-vropsIntegrationUser] <String> [-vropsIntegrationPass] <String> [-vropsIntegrationName] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## Description
@@ -29,7 +27,7 @@ The cmdlet connects to SDDC Manager using the -server, -user, and -password valu
 ### Example 1
 
 ```powershell
-New-vRAvROPSIntegrationItem -server "sfo-vcf01.sfo.rainpole.io" -user "administrator@vsphere.local" -pass "VMw@re1!"  -vraUser "configadmin@rainpole.io" -vraPass "VMw@re1!" -vropsIntegrationUser  "svc-vrops-vra@sfo.rainpole.io@vIDMAuthSource" -vropsIntegrationPass "VMw@re1!" -vropsIntegrationName "VMware Aria Operations"
+New-vRAvROPSIntegrationItem -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1!  -vraUser configadmin -vraPass VMw@re1! -vropsIntegrationUser svc-vrops-vra@sfo.rainpole.io@vIDMAuthSource -vropsIntegrationPass VMw@re1! -vropsIntegrationName 'VMware Aria Operations'
 ```
 
 This example creates VMware Aria Operations integration with name "VMware Aria Operations" in VMware Aria Automation.

diff --git a/...tation/functions/aria-suite/aria-operations/Update-vROPSvRAAdapterCredential.md b/...tation/functions/aria-suite/aria-operations/Update-vROPSvRAAdapterCredential.md
@@ -7,15 +7,12 @@ Update the credential of VMware Aria Automation adapter in VMware Aria Operation
 ## Syntax
 
 ```powershell
-Update-vROPSvRAAdapterCredential [-server] <String> [-user] <String> [-pass] <String>
- [-credential_displayname] <String> [-credential_username] <String> [-credential_password] <String>
- [-adapterKind] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Update-vROPSvRAAdapterCredential [-server] <String> [-user] <String> [-pass] <String> [-credentialUsername] <String> [-credentialPassword] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## Description
 
-The `Update-vROPSvRAAdapterCredential` cmdlet update the credential of VMware Aria Automation adapter in VMware
-Aria Operations.
+The `Update-vROPSvRAAdapterCredential` cmdlet update the credential of VMware Aria Automation adapter in VMware Aria Operations.
 The cmdlet connects to SDDC Manager using the -server, -user, and -password values.
 
 - Validates that network connectivity and authentication is possible to SDDC Manager
@@ -33,10 +30,10 @@ The cmdlet connects to SDDC Manager using the -server, -user, and -password valu
 ### Example 1
 
 ```powershell
-Update-vROPSvRAAdapterCredential -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -credential_displayname "VMware Aria Automation Credentials" -credential_username svc-vrops-vra@sfo.rainpole.io -credential_password VMw@re1! -adapterKind CASAdapter
+Update-vROPSvRAAdapterCredential -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -credentialUsername svc-vrops-vra@sfo.rainpole.io -credentialPassword VMw@re1!
 ```
 
-This example update the credential of VMware Aria Automation adapter with name "VMware Aria Automation Credentials" in VMware Aria Operations.
+This example update the credential of VMware Aria Automation adapter in VMware Aria Operations.
 
 ## Parameters
 
@@ -88,23 +85,7 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -credential_displayname
-
-The credential display name.
-
-```yaml
-Type: String
-Parameter Sets: (All)
-Aliases:
-
-Required: True
-Position: 4
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -credential_username
+### -credentialUsername
 
 The credential user name.
 
@@ -120,7 +101,7 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -credential_password
+### -credentialPassword
 
 The credential password.
 
@@ -136,22 +117,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -adapterKind
-
-The adapter kind.
-
-```yaml
-Type: String
-Parameter Sets: (All)
-Aliases:
-
-Required: True
-Position: 7
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -ProgressAction
 
 Progress Action

diff --git a/docs/documentation/functions/solutions/iom/index.md b/docs/documentation/functions/solutions/iom/index.md
@@ -86,8 +86,8 @@ Select an option for the solution.
 
     | Function                                                                                                          | Type                  |
     | ------------------------------------------------------------------------------------------------------------------| --------------------- |
-    | [`Export-IomJsonSpec`](Export-IomJsonSpec.md)                                                                     | End-to-End Removal    |
-    | [`Invoke-IomSolutionInterop`](Invoke-IomSolutionInterop.md)                                                       | End-to-End Removal    |
+    | [`Export-IomJsonSpec`](Export-IomJsonSpec.md)                                                                     | End-to-End Deployment |
+    | [`Invoke-IomSolutionInterop`](Invoke-IomSolutionInterop.md)                                                       | End-to-End Deployment |
     | [`Add-vRLIAgentGroup`](./../../aria-suite/aria-operations-logs/Add-vRLIAgentGroup.md)                             | Procedure             |
     | [`Request-vROpsLogForwardingConfig`](./../../aria-suite/aria-operations/Request-vROpsLogForwardingConfig.md)      | Procedure             |
 
@@ -97,8 +97,8 @@ Select an option for the solution.
 
     | Function                                                                                                          | Type                  |
     | ------------------------------------------------------------------------------------------------------------------| --------------------- |
-    | [`Export-IomJsonSpec`](Export-IomJsonSpec.md)                                                                     | End-to-End Deployment |
-    | [`Invoke-UndoIomSolutionInterop`](Invoke-UndoIomSolutionInterop.md)                                               | End-to-End Deployment |
+    | [`Export-IomJsonSpec`](Export-IomJsonSpec.md)                                                                     | End-to-End Removal    |
+    | [`Invoke-UndoIomSolutionInterop`](Invoke-UndoIomSolutionInterop.md)                                               | End-to-End Removal    |
     | [`Undo-vRLIAgentGroup`](./../../aria-suite/aria-operations-logs/Undo-vRLIAgentGroup.md)                           | Procedure             |
     | [`Request-vROpsLogForwardingConfig`](./../../aria-suite/aria-operations/Request-vROpsLogForwardingConfig.md)      | Procedure             |
 

diff --git a/docs/documentation/functions/solutions/pca/Invoke-PcaSolutionInterop.md b/docs/documentation/functions/solutions/pca/Invoke-PcaSolutionInterop.md
@@ -0,0 +1,50 @@
+# Invoke-PcaSolutionInterop
+
+## Synopsis
+
+Configure solution interoperability for Private Cloud Automation.
+
+## Syntax
+
+```powershell
+Invoke-PcaSolutionInterop [-jsonFile] <String> [<CommonParameters>]
+```
+
+## Description
+
+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:
+
+- Monitoring and Alerting
+- Logging
+
+## Examples
+
+### Example 1
+
+```powershell
+Invoke-PcaSolutionInterop -jsonFile .\pcaDeploySpec.json
+```
+
+This example configures solution interoperability of the Private Cloud Automation for VMware Cloud Foundation using the JSON spec supplied
+
+## Parameters
+
+### -jsonFile
+
+The JSON (.json) file created.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### Common Parameters
+
+This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
diff --git a/docs/documentation/functions/solutions/pca/Invoke-UndoPcaSolutionInterop.md b/docs/documentation/functions/solutions/pca/Invoke-UndoPcaSolutionInterop.md
@@ -0,0 +1,49 @@
+# Invoke-UndoPcaSolutionInterop
+
+## Synopsis
+
+Remove solution interoperability for Private Cloud Automation.
+
+## Syntax
+
+```powershell
+Invoke-UndoPcaSolutionInterop [-jsonFile] <String> [<CommonParameters>]
+```
+
+## Description
+
+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:
+
+- Monitoring and Alerting
+
+## Examples
+
+### Example 1
+
+```powershell
+Invoke-UndoPcaSolutionInterop -jsonFile .\pcaDeploySpec.json
+```
+
+This example removes solution interoperability of the Private Cloud Automation for VMware Cloud Foundation using the JSON spec supplied.
+
+## Parameters
+
+### -jsonFile
+
+The JSON (.json) file created.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### Common Parameters
+
+This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
diff --git a/docs/documentation/functions/solutions/pca/index.md b/docs/documentation/functions/solutions/pca/index.md
@@ -74,13 +74,26 @@ Select an option for the solution.
 
     The following functions can be use for the solution interoperability.
 
-    | Function                                                                                                     | Type      |
-    | ------------------------------------------------------------------------------------------------------------ | --------- |
-    | [`New-vRAvROPSIntegrationItem`](./../../aria-suite/aria-automation/New-vRAvROPSIntegrationItem.md)           | Procedure |
-    | [`Add-vRAUser`](./../../aria-suite/aria-automation/Add-vRAUser.md)                                           | Procedure |
-    | [`Update-vROPSvRAAdapterCredential`](./../../aria-suite/aria-operations/Update-vROPSvRAAdapterCredential.md) | Procedure |
-    | [`Update-vRACloudAccountZone`](./../../aria-suite/aria-automation/Update-vRACloudAccountZone.md)             | Procedure |
-    | [`Add-vROPSAdapterPing`](./../../aria-suite/aria-operations/Add-vROPSAdapterPing.md)                         | Procedure |
-    | [`Add-vRLIAgentGroup`](./../../aria-suite/aria-operations-logs/Add-vRLIAgentGroup.md)                        | Procedure |
+    | Function                                                                                                     | Type                  |
+    | ------------------------------------------------------------------------------------------------------------ | --------------------- |
+    | [`Export-PcaJsonSpec`](Export-PcaJsonSpec.md)                                                                | End-to-End Deployment |
+    | [`Invoke-PcaSolutionInterop`](Invoke-PcaSolutionInterop.md)                                                  | End-to-End Deployment |
+    | [`New-vRAvROPSIntegrationItem`](./../../aria-suite/aria-automation/New-vRAvROPSIntegrationItem.md)           | Procedure             |
+    | [`Add-vRAUser`](./../../aria-suite/aria-automation/Add-vRAUser.md)                                           | Procedure             |
+    | [`Update-vROPSvRAAdapterCredential`](./../../aria-suite/aria-operations/Update-vROPSvRAAdapterCredential.md) | Procedure             |
+    | [`Update-vRACloudAccountZone`](./../../aria-suite/aria-automation/Update-vRACloudAccountZone.md)             | Procedure             |
+    | [`Add-vROPSAdapterPing`](./../../aria-suite/aria-operations/Add-vROPSAdapterPing.md)                         | Procedure             |
+    | [`Add-vRLIAgentGroup`](./../../aria-suite/aria-operations-logs/Add-vRLIAgentGroup.md)                        | Procedure             |
+
+=== ":material-transit-connection-variant: &nbsp; Solution Interoperability Removal"
+
+    The following functions can be use for the solution interoperability.
+
+    | Function                                                                                                          | Type                  |
+    | ------------------------------------------------------------------------------------------------------------------| --------------------- |
+    | [`Export-PcaJsonSpec`](Export-PcaJsonSpec.md)                                                                     | End-to-End Removal    |
+    | [`Invoke-UndoPcaSolutionInterop`](Invoke-UndoPcaSolutionInterop.md)                                               | End-to-End Removal    |
+    | [`Undo-vROPSAdapter`](./../../aria-suite/aria-operations/Undo-vROPSAdapter.md)                                    | Procedure             |
+    | [`Undo-vRLIAgentGroup`](./../../aria-suite/aria-operations-logs/Undo-vRLIAgentGroup.md)                           | Procedure             |
 
 [solution]: https://docs.vmware.com/en/VMware-Cloud-Foundation/services/vcf-private-cloud-automation-v1/GUID-33896484-4331-46F1-8875-B487BBEDCE05.html
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -943,7 +943,9 @@ nav:
       - Private Cloud Automation:
         - documentation/functions/solutions/pca/Export-PcaJsonSpec.md
         - documentation/functions/solutions/pca/Invoke-PcaDeployment.md
+        - documentation/functions/solutions/pca/Invoke-PcaSolutionInterop.md
         - documentation/functions/solutions/pca/Invoke-UndoPcaDeployment.md
+        - documentation/functions/solutions/pca/Invoke-UndoPcaSolutionInterop.md
         - documentation/functions/solutions/pca/Request-PcaMscaSignedCertificate.md
         - documentation/functions/solutions/pca/Test-PcaPrerequisite.md
       - Site Protection and Disaster Recovery: