Get-ITGlueConfigurationInterface
SYNOPSIS
Retrieve a configuration(s) interface(s)
SYNTAX
Index (Default)
Get-ITGlueConfigurationInterface [-ConfigurationID <Int64>] [-FilterID <Int64>] [-FilterIPAddress <String>]
[-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>] [-AllResults] [<CommonParameters>]
Show
Get-ITGlueConfigurationInterface [-ConfigurationID <Int64>] -ID <Int64> [<CommonParameters>]
DESCRIPTION
The Get-ITGlueConfigurationInterface cmdlet retrieves a configuration(s) interface(s)
This function can call the following endpoints: Index = /configurations/:conf_id/relationships/configuration_interfaces
Show = /configuration_interfaces/:id
/configurations/:id/relationships/configuration_interfaces/:id
EXAMPLES
EXAMPLE 1
Get-ITGlueConfigurationInterface -ConfigurationID 8765309
Gets an index of all the defined configurations interfaces
EXAMPLE 2
Get-ITGlueConfigurationInterface -ConfigurationID 8765309 -ID 8765309
Gets an a defined interface from a defined configuration
EXAMPLE 3
Get-ITGlueConfigurationInterface -ConfigurationID 8765309 -ID 8765309
Gets a defined interface from a defined configuration
EXAMPLE 4
Get-ITGlueConfigurationInterface -ID 8765309
Gets a defined interface
PARAMETERS
-ConfigurationID
A valid configuration ID in your account
Type: Int64
Parameter Sets: (All)
Aliases: conf_id, configuration_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ID
A valid configuration interface ID in your account
Type: Int64
Parameter Sets: Show
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-FilterID
Configuration id to filter by
Type: Int64
Parameter Sets: Index
Aliases: filter_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-FilterIPAddress
IP address to filter by
Type: String
Parameter Sets: Index
Aliases: filter_ip_address
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sort
Sort results by a defined value
Allowed values: ‘created_at’, ‘updated_at’, ‘-created_at’, ‘-updated_at’
Type: String
Parameter Sets: Index
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PageNumber
Return results starting from the defined number
Type: Int64
Parameter Sets: Index
Aliases: page_number
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of results to return per page
The maximum number of page results that can be requested is 1000
Type: Int32
Parameter Sets: Index
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-AllResults
Returns all items from an endpoint
This can be used in unison with -PageSize to limit the number of sequential requests to the API
Type: SwitchParameter
Parameter Sets: Index
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
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
OUTPUTS
NOTES
N/A
RELATED LINKS
https://api.itglue.com/developer/#configuration-interfaces-index