Get-NBDCIMConnectedDevice
Since
v4.4.10.0
SYNOPSIS
Retrieves Connected Device objects from Netbox DCIM module.
SYNTAX
Get-NBDCIMConnectedDevice [-Peer_Device] <String> [-Peer_Interface] <String> [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves the connected device for a given peer device and interface. Returns a single device object (no pagination).
EXAMPLES
EXAMPLE 1
Get-NBDCIMConnectedDevice -Peer_Device "switch01" -Peer_Interface "GigabitEthernet0/1"
PARAMETERS
-Peer_Device
The name of the peer device.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Peer_Interface
The name of the peer interface.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response instead of the results array.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
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
System.Management.Automation.PSObject
NOTES
AddedInVersion: v4.4.10.0