Get-NectarCiscoClusterInventory
- 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarCiscoClusterInventory
- Updated on 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Return inventory information for a given Cisco cluster
Syntax
Get-NectarCiscoClusterInventory
-ClusterID <String>
-InventorySet <String>
-SearchQuery <String>
-OrderByField <String>
-OrderDirection <String>
-TenantName <String>
-PageSize <Int32>
-ResultSize <Int32>
-Name <String>
Examples
Example 1
Get-NectarCiscoClusterInventory -ClusterID 39_1 -InventorySet CallManagers
Returns information about the call managers for the specified clusterID
Example 2
Get-NectarCiscoCluster | Get-NectarCiscoClusterInventory -InventorySet Gateways
Returns information about gateways from all Cisco clusters
Parameters
-ClusterID <String>
The Nectar-defined ClusterID for the given cluster. Accepts pipelined results
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-InventorySet <String>
What specified inventory set to pull information about
| Parameter | Value |
|---|---|
| Required | true |
| Position | 2 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-SearchQuery <String>
A string to search for. Will search for match against all fields
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-OrderByField <String>
Sort the output by the selected field
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | idx |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-OrderDirection <String>
Sort ordered output in ascending or descending order
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | asc |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-PageSize <Int32>
The size of the page used to return data. Defaults to 10000
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | 10000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-ResultSize <Int32>
The total number of results to return. Maximum result size is 9,999,999 results
| Parameter | Value |
|---|---|
| Required | false |
| Position | 8 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Name <String>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 9 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?