Get-AlConnectorConfig
SYNOPSIS
Retrieves Platform Connector Configurations. Returns all configurations by default, or can filter by a specific name or supported features.
SYNTAX
Default (Default)
Get-AlConnectorConfig [-ConnectionId <Guid>] [<CommonParameters>]
<!--NeedCopy-->
ByName
Get-AlConnectorConfig -Name <String> [-ConnectionId <Guid>] [<CommonParameters>]
<!--NeedCopy-->
ByFeatures
Get-AlConnectorConfig -Features <PlatformConnectorFeatures> [-ConnectionId <Guid>] [<CommonParameters>]
<!--NeedCopy-->
DESCRIPTION
The Get-AlConnectorConfig cmdlet retrieves information about available Platform Connector Configurations.
By default, when run without any parameters, this cmdlet returns a list of all available Platform Connector Configurations.
You can optionally filter the results using one of the following mutually exclusive parameters:
- Use the
-Nameparameter to retrieve a specific configuration by its exact name. The comparison is case-insensitive. If a configuration with the matching name exists, only that configuration will be returned. - Use the
-Featuresparameter to retrieve only configurations that support all of the specified features. Provide the desired features as a comma-separated string (e.g., -Features ‘IpsExport, IpsDiagnostics’). The cmdlet will return all configurations matching any of the provided features.
You can use either the -Name parameter OR the -Features parameter to filter the list, but you cannot use both parameters in the same command.
Specifying either -Name or -Features overrides the default behavior and returns only the filtered results.
EXAMPLES
Example 1
PS C:\> Get-AlConnectorConfig
<!--NeedCopy-->
Retrieves all configurations.
Example 2
PS C:\> Get-AlConnectorConfig -Name "My Connector"
<!--NeedCopy-->
Searches for a specific connector configuration named “My Connector”. The name is case-insensitive.
Example 3
PS C:\> Get-AlConnectorConfig -Features IpsExport, IpsDiagnostics
<!--NeedCopy-->
Searches for all configurations that support both the IpsExport and IpsDiagnostics features.
PARAMETERS
-ConnectionId
Specifies the connection to the App Layering Appliance to use for this operation.
This is the GUID returned by Connect-AlAppliance.
If omitted, the command uses the current connection automatically if it’s the only one active. When multiple sessions are active, the GUID of the most recently used connection is used.
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Features
Filters connector configurations based on their supported features. Provide one or more comma-separated feature flags (e.g., ‘IpsExport,IpsPrepare’).
Type: PlatformConnectorFeatures
Parameter Sets: ByFeatures
Aliases:
Accepted values: None, Import, Create, Publish, All, DiskCaching, Offloading, Deprecated, AllowCreate, IpsExport, IpsPrepare
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Name
The name of the connector configuration to target. An exact, case-insensitive match is performed.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
[PlatformConnectorConfigSummary[]] (Array)
Returns an array of connector configuration summaries. Each object contains the Id, Name, and PlatformName of a configured platform connector.
- Id [String]
- Name [String]
- PlatformName [String]