feat: verify integration aria automation integration (#539)

- Updated `Get-vRAIntegrationDetail` to get output so that it can feed into `Get-vRAIntegrationDetailvROPSStatus`. - Updated `xreg-` to `xint-` where applicable in examples. Signed-off-by: Jared Burns <jared.burns@broadcom.com> Co-authored-by: Ryan Johnson <ryan.johnson@broadcom.com>
vmware · Mar 20, 2024 · 83938e5 · 83938e5
1 parent 3add0a5
commit 83938e5
Show file tree

Hide file tree

Showing 12 changed files with 189 additions and 75 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -80,6 +80,7 @@
 - Enhanced `Invoke-***Deployment` and `Invoke-Undo***Deployment` functions to use the `messageHandler` function.
 - Enhanced `Get-vRSLCMProductDetails` cmdlet with the `vmid` option to get the details for a specific product in VMware Aria Suite Lifecycle.
 - Enhanced `Get-vRLIMarketplaceMetadata` and `Enable-vRLIContentPack` cmdlets to accept a GitHub token that is either non-base64 or base64 encoded. If not encoded, the cmdlet will based64 encode it automatically.
+- Enhanced `Get-vRAIntegrationDetail` cmdlet with an integration status check option.
 
 ## v2.8.0
 

diff --git a/PowerValidatedSolutions.psd1 b/PowerValidatedSolutions.psd1
@@ -3,15 +3,15 @@
 
 # Module manifest for module 'PowerValidatedSolutions'
 # Generated by: Broadcom
-# Generated on: 2024-03-18
+# Generated on: 2024-03-26
 
 @{
 
     # Script module or binary module file associated with this manifest.
     RootModule        = 'PowerValidatedSolutions.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '2.9.0.1041'
+    ModuleVersion     = '2.9.0.1042'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

diff --git a/PowerValidatedSolutions.psm1 b/PowerValidatedSolutions.psm1
diff --git a/.../documentation/functions/aria-suite/aria-automation/Get-vRAIntegrationDetail.md b/.../documentation/functions/aria-suite/aria-automation/Get-vRAIntegrationDetail.md
@@ -2,13 +2,21 @@
 
 ## Synopsis
 
-Get an integration detail of an item from VMware Aria Automation
+Get an integration detail of an item from VMware Aria Automation.
 
 ## Syntax
 
+### Status (Default)
+
+```powershell
+Get-vRAIntegrationDetail -integrationType <String> [-integrationName <String>] [-getStatus] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+### ID
+
 ```powershell
-Get-vRAIntegrationDetail [-integrationType] <String> [[-integrationName] <String>] [-getVCID]
- [-getIntegrationID] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Get-vRAIntegrationDetail -integrationType <String> [-integrationName <String>] [-getVCID] [-getIntegrationID]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## Description
@@ -23,29 +31,45 @@ The `Get-vRAIntegrationDetail` cmdlet returns an integration details of an item
 Get-vRAIntegrationDetail -integrationType "vrops" -getVCID
 ```
 
-This example returns the ids of the vCenter Server instances managed by the VMware Aria Operations
+This example returns the ids of the vCenter Server instances managed by the VMware Aria Operations.
 
 ### Example 2
 
 ```powershell
 Get-vRAIntegrationDetail -integrationType "vrops" -integrationName "VMware Aria Operations" -getIntegrationID
 ```
 
-This example returns the integration id of "VMware Aria Operations" which is integrated with the VMwareAria Automation.
+This example returns the integration id of "VMware Aria Operations" which is integrated with the VMware Aria Automation.
+
+
+### Example 3
+
+```powershell
+Get-vRAIntegrationDetail -integrationType "vrops" -getStatus
+```
+This example returns the integration status of all VMware Aria Operations integrations in VMware Aria Automation.
+
+### Example 4
+
+```powershell
+Get-vRAIntegrationDetail -integrationType "vrops" -integrationName "VMware Aria Operations" -getStatus
+```
+
+This example returns the integration status of "VMware Aria Operations" which is integrated with the VMware Aria Automation.
 
-## Parameters
+## PARAMETERS
 
 ### -integrationType
 
-The integration type to get details for, supports vrops.
+The integration type to get details for. One of `vrops` or `vro`.
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 1
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -61,7 +85,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 2
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -73,7 +97,7 @@ Get the vCenter Server instance ids managed by the VMware Aria Operations.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: ID
 Aliases:
 
 Required: False
@@ -89,7 +113,23 @@ Get the integration id of the integration name provided.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: ID
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -getStatus
+
+Get the status of the integration type and/or name provided.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: Status
 Aliases:
 
 Required: False

diff --git a/docs/documentation/functions/aria-suite/aria-automation/Request-vRAToken.md b/docs/documentation/functions/aria-suite/aria-automation/Request-vRAToken.md
@@ -21,15 +21,15 @@ It is required once per session before running all other cmdlets.
 ### Example 1
 
 ```powershell
-Request-vRAToken -fqdn xreg-vra01.rainpole.io -username configadmin -password VMware1!
+Request-vRAToken -fqdn xint-vra01.rainpole.io -username configadmin -password VMware1!
 ```
 
 This example shows how to connect to the VMware Aria Automation appliance
 
 ### Example 2
 
 ```powershell
-Request-vRAToken -fqdn xreg-vra01.rainpole.io -username configadmin -password VMware1! -displayToken
+Request-vRAToken -fqdn xint-vra01.rainpole.io -username configadmin -password VMware1! -displayToken
 ```
 
 This example shows how to connect to the VMware Aria Automation appliance and display the token needed for Terraform.

diff --git a/.../documentation/functions/aria-suite/aria-suite-lifecycle/Request-vRSLCMToken.md b/.../documentation/functions/aria-suite/aria-suite-lifecycle/Request-vRSLCMToken.md
@@ -21,7 +21,7 @@ It is required once per session before running all other cmdlets.
 ### Example 1
 
 ```powershell
-Request-vRSLCMToken -fqdn xreg-vrslcm.rainpole.io -username admin@local -password VMware1!
+Request-vRSLCMToken -fqdn xint-vrslcm.rainpole.io -username admin@local -password VMware1!
 ```
 
 This example shows how to connect to the VMware Aria Suite Lifecycle appliance.

diff --git a/docs/documentation/functions/nsx/Add-CertToNsxCertificateStore.md b/docs/documentation/functions/nsx/Add-CertToNsxCertificateStore.md
@@ -19,7 +19,7 @@ The `Add-CertToNsxCertificateStore` cmdlet adds a Certificate to the NSX Certifi
 ### Example 1
 
 ```powershell
-Add-CertToNsxCertificateStore -certName sfo-w01-ec01-xreg-wsa
+Add-CertToNsxCertificateStore -certName sfo-w01-ec01-xint-wsa
 ```
 
 This example adds a Certificate to the NSX Certificate Store.

diff --git a/docs/documentation/functions/nsx/New-NsxtSegment.md b/docs/documentation/functions/nsx/New-NsxtSegment.md
@@ -20,10 +20,10 @@ The `New-NsxtSegment` cmdlet creates NSX Segments.
 ### Example 1
 
 ```powershell
-New-NsxtSegment -Name "sfo-w01-xreg-seg01" -GatewayType "Tier1" -ConnectedGateway "sfo-w01-ec01-t1-gw01" -Cidr "192.168.31.1/24" -TransportZone "overlay-tz-sfo-w01-nsx01.sfo.rainpole.io"
+New-NsxtSegment -Name "sfo-w01-xint-seg01" -GatewayType "Tier1" -ConnectedGateway "sfo-w01-ec01-t1-gw01" -Cidr "192.168.31.1/24" -TransportZone "overlay-tz-sfo-w01-nsx01.sfo.rainpole.io"
 ```
 
-This example creates an NSX Overlay Segment with the name "sfo-w01-xreg-seg01", connected to Tier-1 gateway "sfo-w01-ec01-t1-gw01", Transport Zone "overlay-tz-sfo-w01-nsx01.sfo.rainpole.io", and CIDR address of "192.168.31.1/24".
+This example creates an NSX Overlay Segment with the name "sfo-w01-xint-seg01", connected to Tier-1 gateway "sfo-w01-ec01-t1-gw01", Transport Zone "overlay-tz-sfo-w01-nsx01.sfo.rainpole.io", and CIDR address of "192.168.31.1/24".
 
 ## Parameters
 

diff --git a/docs/documentation/functions/vsphere/Add-AntiAffinityRule.md b/docs/documentation/functions/vsphere/Add-AntiAffinityRule.md
@@ -27,7 +27,7 @@ the -server, -user, and -password values:
 ### Example 1
 
 ```powershell
-Add-AntiAffinityRule -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -ruleName sfo-m01-anti-affinity-rule-wsa -antiAffinityVMs "xreg-wsa01a,xreg-wsa01b,xreg-wsa01c"
+Add-AntiAffinityRule -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -ruleName sfo-m01-anti-affinity-rule-wsa -antiAffinityVMs "xint-wsa01a,xint-wsa01b,xint-wsa01c"
 This example shows how to create a vSphere Anti-Affinity rule in the vCenter Server of the sfo-m01 workload domain
 ```
 

diff --git a/docs/documentation/functions/vsphere/Add-ClusterGroup.md b/docs/documentation/functions/vsphere/Add-ClusterGroup.md
@@ -27,7 +27,7 @@ The cmdlet connects to SDDC Manager using the
 ### Example 1
 
 ```powershell
-Add-ClusterGroup -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -drsGroupName "xint-vm-group-wsa" -drsGroupVMs "xreg-wsa01a,xreg-wsa01b,xreg-wsa01c"
+Add-ClusterGroup -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -drsGroupName "xint-vm-group-wsa" -drsGroupVMs "xint-wsa01a,xint-wsa01b,xint-wsa01c"
 ```
 
 This example shows how to create a vSphere DRS Cluster group in the vCenter Server of the sfo-m01 workload domain.

diff --git a/docs/documentation/functions/vsphere/Get-VMOvfProperty.md b/docs/documentation/functions/vsphere/Get-VMOvfProperty.md
@@ -19,10 +19,10 @@ The `Get-VMOvfProperty` cmdlet returns OVF properties of a virtual appliance.
 ### Example 1
 
 ```powershell
-Get-VMOvfProperty -vm (Get-VM -Name xreg-wsa01a)
+Get-VMOvfProperty -vm (Get-VM -Name xint-wsa01a)
 ```
 
-This example returns an object that contains a full list of OVF properties for xreg-wsa01a.
+This example returns an object that contains a full list of OVF properties for xint-wsa01a.
 
 ## Parameters
 

diff --git a/docs/documentation/functions/vsphere/Set-VMOvfProperty.md b/docs/documentation/functions/vsphere/Set-VMOvfProperty.md
@@ -20,10 +20,10 @@ appliance.
 ### Example 1
 
 ```powershell
-Set-VMOvfProperty -vm (Get-VM -Name xreg-wsa01a) -Properties @{"DNS"="172.16.11.4,172.16.11.5"}
+Set-VMOvfProperty -vm (Get-VM -Name xint-wsa01a) -Properties @{"DNS"="172.16.11.4,172.16.11.5"}
 ```
 
-This example sets the DNS servers to 172.16.11.4 and 172.16.11.5 in the OVF properties for xreg-wsa01a.
+This example sets the DNS servers to 172.16.11.4 and 172.16.11.5 in the OVF properties for xint-wsa01a.
 
 ## Parameters