PowervRLICloud 1.0 Documentation

Connect-vRLI-Cloud

Connects to vRLI Cloud and gets CSP Access Token to be used with APIs

This cmdlet creates $global:defaultvRLICConnection object

Syntax 

Connect-vRLI-Cloud [-APIToken] <SecureString> [[-Region] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-APIToken vRLI Cloud API Token true false
-Region Deployment Name false false us

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Connect-vRLI-Cloud -APIToken $APIToken
Input APIToken as Secure String by using Read-Host "$APIToken = Read-Host -AsSecureString"

Top of page

Create-AccessKey

Creates vRLIC Access Key in a particular Org

This cmdlet creates vRLIC Access Key in a particular Org

Syntax 

Create-AccessKey [[-Connection] <PSObject>] [-KeyName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-KeyName Key Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Create-AccessKey -KeyName "MMTest"

Top of page

Disconnect-vRLI-Cloud

Destroys $global:defaultvRLICConnection object if it exists

REST is not connection oriented, so there really isnt a connect/disconnect concept. It destroys $global:defaultvRLICConnection object if it exists

Syntax 

Disconnect-vRLI-Cloud [<CommonParameters>]

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Disconnect-vRLI-Cloud

Top of page

Get-AccessKey

Returns vRLIC Access Key details in a particular Org

This cmdlet retrieves vRLIC Access Key details in a particular Org

Syntax 

Get-AccessKey [[-Connection] <PSObject>] [-KeyName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-KeyName Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-AccessKey -KeyName "MMTest"

Top of page

Get-AlertDefinitions

Returns vRLIC Alert Definitions in a particular Org

This cmdlet retrieves vRLIC Alert Definitions in a particular Org

Syntax 

Get-AlertDefinitions [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-AlertDefinitions | where{$_.name -match "Test"}

Top of page

Get-AlertInstanceById

Returns vRLIC Alert Instance in a particular Org

This cmdlet retrieves vRLIC Alert Instance in a particular Org

Syntax 

Get-AlertInstanceById [[-Connection] <PSObject>] [-Id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-Id Alert Instance ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-AlertInstanceById -Id "xxx444"

Top of page

Get-AlertInstances

Returns vRLIC all Alert Instances in a particular Org

This cmdlet retrieves vRLIC all Alert Instances in a particular Org

Syntax 

Get-AlertInstances [[-Connection] <PSObject>] [-Duration] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-Duration Duration in Mins true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-AlertInstances -Duration 60

Top of page

Get-ContentPack-Dashboards

Returns vRLIC Content Pack Dashboards in a particular Org

This cmdlet retrieves vRLIC Content Pack Dashboards in a particular Org

Syntax 

Get-ContentPack-Dashboards [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-ContentPack-Dashboards | where{$_.name -match "Test"}

Top of page

Get-CurrentDataset

Returns vRLIC current dataset in a particular Org

This cmdlet retrieves vRLIC current dataset in a particular Org

Syntax 

Get-CurrentDataset [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-CurrentDataset

Top of page

Get-CurrentRole

Returns vRLIC current role in a particular Org

This cmdlet retrieves vRLIC current role in a particular Org

Syntax 

Get-CurrentRole [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-CurrentRole

Top of page

Get-Datasets

Returns vRLIC roles in a particular Org

This cmdlet retrieves vRLIC roles in a particular Org

Syntax 

Get-Datasets [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-Datasets | where{$_.name -match "Test"}

Top of page

Get-Favourite-Dashboards

Returns vRLIC Favourite Dashboards in a particular Org

This cmdlet retrieves vRLIC Favourite Dashboards in a particular Org

Syntax 

Get-Favourite-Dashboards [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-ContentPack-Dashboards | where{$_.name -match "Test"}

Top of page

Get-QueryResponse

Returns vRLIC gets a log query by id in a particular Org

This cmdlet retrieves vRLIC log query by id in a particular Org

Syntax 

Get-QueryResponse [[-Connection] <PSObject>] [-QueryId] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-QueryId Query ID true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-QueryResponse

Top of page

Get-Roles

Returns vRLIC roles in a particular Org

This cmdlet retrieves vRLIC roles in a particular Org

Syntax 

Get-Roles [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-Roles | where{$_.name -match "Test"}

Top of page

Get-SubscriptionStatus

Returns vRLIC Subscription Status in a particular Org

This cmdlet retrieves vRLIC Subscription Status in a particular Org

Syntax 

Get-SubscriptionStatus [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-SubscriptionStatus | where{$_.name -match "Test"}

Top of page

Get-UsageReport

Returns vRLIC Usage Report in a particular Org

This cmdlet retrieves vRLIC Usage Report in a particular Org

Syntax 

Get-UsageReport [[-Connection] <PSObject>] [-UsageType] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-UsageType Usage Type true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-UsageReport -UsageType "usageType=DATA_INGESTED_NON_BILLABLE_V2&usageType=DATA_INGESTED_BILLABLE_V2"

Top of page

Get-Userdefined-Dashboards

Returns vRLIC User Defined Dashboards in a particular Org

This cmdlet retrieves vRLIC User Defined Dashboards in a particular Org

Syntax 

Get-Userdefined-Dashboards [[-Connection] <PSObject>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Get-Userdefined-Dashboards | where{$_.name -match "Test"}

Top of page

Get-vRLI-CloudCommands

Returns all cmdlets for vRLI Cloud

This cmdlet will allow you to return all cmdlets included in the Power vRLI Cloud Module

Syntax 

Get-vRLI-CloudCommands [<CommonParameters>]

Note

You can either use this cmdlet or the Get-Command cmdlet as seen in Example 2

Examples

EXAMPLE 1 
Get-vRLI-CloudCommands
EXAMPLE 2 
Get-Command -Module PowervRLICloud

Top of page

Post-Query-Request

Creates a log query in a particular Org

This cmdlet creates a log query in a particular Org

Syntax 

Post-Query-Request [[-Connection] <PSObject>] [-SQLQuery] <String> [-Duration] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-SQLQuery SQL Query true false
-Duration Duration in Mins true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Post-Query-Request -SQlQuery "SELECT * FROM logs ORDER BY ingest_timestamp DESC" -Duration 60

Top of page

Remove-AccessKey

Deletes vRLIC Access Key in a particular Org

This cmdlet deletes vRLIC Access Key in a particular Org

Syntax 

Remove-AccessKey [[-Connection] <PSObject>] [-KeyName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-KeyName Key Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Remove-AccessKey -Name "MMTest"

Top of page

Remove-AlertDefinition

Deletes vRLIC Alert Definition in a particular Org

This cmdlet deletes vRLIC Alert Definition in a particular Org

Syntax 

Remove-AlertDefinition [[-Connection] <PSObject>] [-AlertName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Connection vRLIC Connection object false false $defaultvRLICConnection
-AlertName Alert Definition Name true false

Note

============================================================================================================================================== Created by: Munishpal Makhija Version: 1.0 Date: 10/12/2022 Organization: VMware Blog: https://munishpalmakhija.com ==============================================================================================================================================

Examples

EXAMPLE 1 
Remove-AlertDefinition -Name "Test"}

Top of page