Skip to main content

Get-LXC1Managers

This cmdlet returns a list of all management hubs (managers) or a specific hub.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Get-LXC1Managers  -ID String
                 [-Connection LXC1Connection]
                 [CommonParameter]

Get-LXC1Managers  [-Status String[]]
                  [-hubCount Int32[]]
                  [-Name String[]]
                  [-NameSearchType String]
                  [-IPAddress String[]]
                  [-IPAddressSearchType String]
                  [-Location String[]]
                  [-LocationSearchType String]
                  [-Anywhere String[]]
                  [-AnywhereSearchType String]
                  [-Connection LXC1Connection]
                  [CommonParameter]
Parameters
-ID String
Specifies the ID of the hub to return.
-Status String[]

Specifies one or more hub statuses. All hubs in any of the specified statuses are returned. This can be one or more of the following values, separated by a comma.

  • healthy
  • warning
  • critical
  • unknown
-DeviceCount Int32[]
Specifies the number of managed devices, as range using the following format: <minimum>,<maximum>. All hubs that have a managed-device count in the specified range are returned.
-IPAddress String[]
Specifies one or more full or partial IP addresses or FQDNs, separated by comma. All hubs that match any of the specified patterns based on the operator (-IPAddressSearchType parameter) are returned.
-IPAddressSearchType String
Specifies the operator to use for patterns in the -IPAddress parameter. This can be one of the following values.
  • contains (default)
  • notContains
  • equals
  • notEquals

If -IPAddress is not specified, this parameter is ignored.

-Name String[]
Specifies one or more full or partial hub names, separated by comma. All hubs that match any of the specified patterns based on the operator (-NameSearchType parameter) are returned.
-NameSearchType String
Specifies the operator to use for patterns in the -Name parameter. This can be one of the following values.
  • contains (default)
  • notContains
  • equals
  • notEquals

If -Name is not specified, this parameter is ignored.

-LocationString[]
Specifies one or more full or partial hub locations (countries), separated by comma. All hubs that match any of the specified patterns based on the operator (-LocationSearchType parameter) are returned.
-LocationSearchType String
Specifies the operator to use for patterns in the -Location parameter. This can be one of the following values.
  • contains (default)
  • notContains
  • equals
  • notEquals

If -Location is not specified, this parameter is ignored.

-Anywhere String[]
Specifies one or more full or partial text found in any hub attributes, separated by a comma. All hubs that match any of the specified patterns based on the operator (-AnywhereSearchType parameter) are returned.
-AnywhereSearchType String
Specifies the operator to use for patterns in the -Anywhere parameter. This can be one of the following values.
  • contains (default)
  • notContains
  • equals
  • notEquals

If -Anywhere is not specified, this parameter is ignored.

-Connection LXC1Connection
Specifies the connection to the XClarity One server. If no connection is specified, the result from the last Connect-LXC1 cmdlet is used.
CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results​

Examples​

The following example returns information about all hub with a specific number of managed devices.
param ( 
    [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] $ClientID,
    [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] $UserSecret
)

$securePassword = ConvertTo-SecureString $UserSecret -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($ClientID, $securePassword))
$hostOnprem = "192.0.2.0"

$connection = Connect-LXC1 -PortalAddress $hostOnprem `
                           -Credential $cred `
                           -PortalType cloud `
                           -SkipCertificateCheck

$result = Get-LXC1Managers -DevicesCount 200,500

$result|Format-List
The following example returns detailed information about a specific hub.
param ( 
    [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] $ClientID,
    [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] $UserSecret
)

$securePassword = ConvertTo-SecureString $UserSecret -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($ClientID, $securePassword))
$hostOnprem = "192.0.2.0"

$connection = Connect-LXC1 -PortalAddress $hostOnprem `
                           -Credential $cred `
                           -PortalType cloud `
                           -SkipCertificateCheck

$result = Get-LXC1Managers -ID A8E89BBC2C3D40F0826E6278BE2DE1AF

$result|Format-List