Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
iosxe.getInterfacePortChannel
Explore with Pulumi AI
This data source can read the Interface Port Channel configuration.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Pulumi.Iosxe;
return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetInterfacePortChannel.Invoke(new()
    {
        Name = 10,
    });
});
package main
import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupInterfacePortChannel(ctx, &iosxe.LookupInterfacePortChannelArgs{
			Name: 10,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetInterfacePortChannelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = IosxeFunctions.getInterfacePortChannel(GetInterfacePortChannelArgs.builder()
            .name(10)
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";
const example = iosxe.getInterfacePortChannel({
    name: 10,
});
import pulumi
import pulumi_iosxe as iosxe
example = iosxe.get_interface_port_channel(name=10)
variables:
  example:
    fn::invoke:
      Function: iosxe:getInterfacePortChannel
      Arguments:
        name: 10
Using getInterfacePortChannel
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getInterfacePortChannel(args: GetInterfacePortChannelArgs, opts?: InvokeOptions): Promise<GetInterfacePortChannelResult>
function getInterfacePortChannelOutput(args: GetInterfacePortChannelOutputArgs, opts?: InvokeOptions): Output<GetInterfacePortChannelResult>def get_interface_port_channel(device: Optional[str] = None,
                               name: Optional[int] = None,
                               opts: Optional[InvokeOptions] = None) -> GetInterfacePortChannelResult
def get_interface_port_channel_output(device: Optional[pulumi.Input[str]] = None,
                               name: Optional[pulumi.Input[int]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetInterfacePortChannelResult]func LookupInterfacePortChannel(ctx *Context, args *LookupInterfacePortChannelArgs, opts ...InvokeOption) (*LookupInterfacePortChannelResult, error)
func LookupInterfacePortChannelOutput(ctx *Context, args *LookupInterfacePortChannelOutputArgs, opts ...InvokeOption) LookupInterfacePortChannelResultOutput> Note: This function is named LookupInterfacePortChannel in the Go SDK.
public static class GetInterfacePortChannel 
{
    public static Task<GetInterfacePortChannelResult> InvokeAsync(GetInterfacePortChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfacePortChannelResult> Invoke(GetInterfacePortChannelInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetInterfacePortChannelResult> getInterfacePortChannel(GetInterfacePortChannelArgs args, InvokeOptions options)
public static Output<GetInterfacePortChannelResult> getInterfacePortChannel(GetInterfacePortChannelArgs args, InvokeOptions options)
fn::invoke:
  function: iosxe:index/getInterfacePortChannel:getInterfacePortChannel
  arguments:
    # arguments dictionaryThe following arguments are supported:
getInterfacePortChannel Result
The following output properties are available:
- ArpTimeout int
- Set ARP cache timeout
- AutoQos boolClassify 
- Configure classification for untrusted devices
- AutoQos boolClassify Police 
- Configure QoS policing for untrusted devices
- AutoQos boolTrust 
- Trust the DSCP/CoS marking
- AutoQos boolTrust Cos 
- Trust the CoS marking
- AutoQos boolTrust Dscp 
- Trust the DSCP marking
- AutoQos boolVideo Cts 
- Trust the QoS marking of the Cisco Telepresence System
- AutoQos boolVideo Ip Camera 
- Trust the QoS marking of the Ip Video Surveillance camera
- AutoQos boolVideo Media Player 
- Trust the Qos marking of the Cisco Media Player
- AutoQos boolVoip 
- Configure AutoQoS for VoIP
- AutoQos boolVoip Cisco Phone 
- Trust the QoS marking of Cisco IP Phone
- AutoQos boolVoip Cisco Softphone 
- Trust the QoS marking of Cisco IP SoftPhone
- AutoQos boolVoip Trust 
- Trust the DSCP/CoS marking
- BfdEcho bool
- Use echo adjunct as bfd detection mechanism
- BfdEnable bool
- Enable BFD under the interface
- BfdInterval int
- BfdInterval intMin Rx 
- Minimum receive interval capability
- BfdInterval intMultiplier 
- Multiplier value used to compute holddown
- BfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- BfdTemplate string
- BFD template
- Description string
- Interface specific description
- HelperAddresses List<Lbrlabs.Pulumi Package. Iosxe. Outputs. Get Interface Port Channel Helper Address> 
- Specify a destination address for UDP broadcasts
- Id string
- The path of the retrieved object.
- IpAccess stringGroup In 
- IpAccess boolGroup In Enable 
- inbound packets
- IpAccess stringGroup Out 
- IpAccess boolGroup Out Enable 
- outbound packets
- IpArp intInspection Limit Rate 
- Rate Limit
- IpArp boolInspection Trust 
- Configure Trust state
- IpDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- IpDhcp boolSnooping Trust 
- DHCP Snooping trust config
- IpProxy boolArp 
- Enable proxy ARP
- IpRedirects bool
- Enable sending ICMP Redirect messages
- IpUnreachables bool
- Enable sending ICMP Unreachable messages
- Ipv4Address string
- Ipv4AddressMask string
- Ipv6AddressAutoconfig boolDefault 
- Insert default route
- Ipv6AddressDhcp bool
- Obtain IPv6 address from DHCP server
- Ipv6Addresses
List<Lbrlabs.Pulumi Package. Iosxe. Outputs. Get Interface Port Channel Ipv6Address> 
- Ipv6Enable bool
- Enable IPv6 on interface
- Ipv6LinkLocal List<Lbrlabs.Addresses Pulumi Package. Iosxe. Outputs. Get Interface Port Channel Ipv6Link Local Address> 
- Ipv6Mtu int
- Set IPv6 Maximum Transmission Unit
- Ipv6NdRa boolSuppress All 
- Suppress all IPv6 RA
- Name int
- Shutdown bool
- Shutdown the selected interface
- SpanningTree stringGuard 
- Change an interface's spanning tree guard mode
- SpanningTree stringLink Type 
- Specify a link type for spanning tree tree protocol use
- Switchport bool
- TrustDevice string
- trusted device class
- VrfForwarding string
- Configure forwarding table
- Device string
- A device name from the provider configuration.
- ArpTimeout int
- Set ARP cache timeout
- AutoQos boolClassify 
- Configure classification for untrusted devices
- AutoQos boolClassify Police 
- Configure QoS policing for untrusted devices
- AutoQos boolTrust 
- Trust the DSCP/CoS marking
- AutoQos boolTrust Cos 
- Trust the CoS marking
- AutoQos boolTrust Dscp 
- Trust the DSCP marking
- AutoQos boolVideo Cts 
- Trust the QoS marking of the Cisco Telepresence System
- AutoQos boolVideo Ip Camera 
- Trust the QoS marking of the Ip Video Surveillance camera
- AutoQos boolVideo Media Player 
- Trust the Qos marking of the Cisco Media Player
- AutoQos boolVoip 
- Configure AutoQoS for VoIP
- AutoQos boolVoip Cisco Phone 
- Trust the QoS marking of Cisco IP Phone
- AutoQos boolVoip Cisco Softphone 
- Trust the QoS marking of Cisco IP SoftPhone
- AutoQos boolVoip Trust 
- Trust the DSCP/CoS marking
- BfdEcho bool
- Use echo adjunct as bfd detection mechanism
- BfdEnable bool
- Enable BFD under the interface
- BfdInterval int
- BfdInterval intMin Rx 
- Minimum receive interval capability
- BfdInterval intMultiplier 
- Multiplier value used to compute holddown
- BfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- BfdTemplate string
- BFD template
- Description string
- Interface specific description
- HelperAddresses []GetInterface Port Channel Helper Address 
- Specify a destination address for UDP broadcasts
- Id string
- The path of the retrieved object.
- IpAccess stringGroup In 
- IpAccess boolGroup In Enable 
- inbound packets
- IpAccess stringGroup Out 
- IpAccess boolGroup Out Enable 
- outbound packets
- IpArp intInspection Limit Rate 
- Rate Limit
- IpArp boolInspection Trust 
- Configure Trust state
- IpDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- IpDhcp boolSnooping Trust 
- DHCP Snooping trust config
- IpProxy boolArp 
- Enable proxy ARP
- IpRedirects bool
- Enable sending ICMP Redirect messages
- IpUnreachables bool
- Enable sending ICMP Unreachable messages
- Ipv4Address string
- Ipv4AddressMask string
- Ipv6AddressAutoconfig boolDefault 
- Insert default route
- Ipv6AddressDhcp bool
- Obtain IPv6 address from DHCP server
- Ipv6Addresses
[]GetInterface Port Channel Ipv6Address 
- Ipv6Enable bool
- Enable IPv6 on interface
- Ipv6LinkLocal []GetAddresses Interface Port Channel Ipv6Link Local Address 
- Ipv6Mtu int
- Set IPv6 Maximum Transmission Unit
- Ipv6NdRa boolSuppress All 
- Suppress all IPv6 RA
- Name int
- Shutdown bool
- Shutdown the selected interface
- SpanningTree stringGuard 
- Change an interface's spanning tree guard mode
- SpanningTree stringLink Type 
- Specify a link type for spanning tree tree protocol use
- Switchport bool
- TrustDevice string
- trusted device class
- VrfForwarding string
- Configure forwarding table
- Device string
- A device name from the provider configuration.
- arpTimeout Integer
- Set ARP cache timeout
- autoQos BooleanClassify 
- Configure classification for untrusted devices
- autoQos BooleanClassify Police 
- Configure QoS policing for untrusted devices
- autoQos BooleanTrust 
- Trust the DSCP/CoS marking
- autoQos BooleanTrust Cos 
- Trust the CoS marking
- autoQos BooleanTrust Dscp 
- Trust the DSCP marking
- autoQos BooleanVideo Cts 
- Trust the QoS marking of the Cisco Telepresence System
- autoQos BooleanVideo Ip Camera 
- Trust the QoS marking of the Ip Video Surveillance camera
- autoQos BooleanVideo Media Player 
- Trust the Qos marking of the Cisco Media Player
- autoQos BooleanVoip 
- Configure AutoQoS for VoIP
- autoQos BooleanVoip Cisco Phone 
- Trust the QoS marking of Cisco IP Phone
- autoQos BooleanVoip Cisco Softphone 
- Trust the QoS marking of Cisco IP SoftPhone
- autoQos BooleanVoip Trust 
- Trust the DSCP/CoS marking
- bfdEcho Boolean
- Use echo adjunct as bfd detection mechanism
- bfdEnable Boolean
- Enable BFD under the interface
- bfdInterval Integer
- bfdInterval IntegerMin Rx 
- Minimum receive interval capability
- bfdInterval IntegerMultiplier 
- Multiplier value used to compute holddown
- bfdLocal StringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate String
- BFD template
- description String
- Interface specific description
- helperAddresses List<GetInterface Port Channel Helper Address> 
- Specify a destination address for UDP broadcasts
- id String
- The path of the retrieved object.
- ipAccess StringGroup In 
- ipAccess BooleanGroup In Enable 
- inbound packets
- ipAccess StringGroup Out 
- ipAccess BooleanGroup Out Enable 
- outbound packets
- ipArp IntegerInspection Limit Rate 
- Rate Limit
- ipArp BooleanInspection Trust 
- Configure Trust state
- ipDhcp StringRelay Source Interface 
- Set source interface for relayed messages
- ipDhcp BooleanSnooping Trust 
- DHCP Snooping trust config
- ipProxy BooleanArp 
- Enable proxy ARP
- ipRedirects Boolean
- Enable sending ICMP Redirect messages
- ipUnreachables Boolean
- Enable sending ICMP Unreachable messages
- ipv4Address String
- ipv4AddressMask String
- ipv6AddressAutoconfig BooleanDefault 
- Insert default route
- ipv6AddressDhcp Boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses
List<GetInterface Port Channel Ipv6Address> 
- ipv6Enable Boolean
- Enable IPv6 on interface
- ipv6LinkLocal List<GetAddresses Interface Port Channel Ipv6Link Local Address> 
- ipv6Mtu Integer
- Set IPv6 Maximum Transmission Unit
- ipv6NdRa BooleanSuppress All 
- Suppress all IPv6 RA
- name Integer
- shutdown Boolean
- Shutdown the selected interface
- spanningTree StringGuard 
- Change an interface's spanning tree guard mode
- spanningTree StringLink Type 
- Specify a link type for spanning tree tree protocol use
- switchport Boolean
- trustDevice String
- trusted device class
- vrfForwarding String
- Configure forwarding table
- device String
- A device name from the provider configuration.
- arpTimeout number
- Set ARP cache timeout
- autoQos booleanClassify 
- Configure classification for untrusted devices
- autoQos booleanClassify Police 
- Configure QoS policing for untrusted devices
- autoQos booleanTrust 
- Trust the DSCP/CoS marking
- autoQos booleanTrust Cos 
- Trust the CoS marking
- autoQos booleanTrust Dscp 
- Trust the DSCP marking
- autoQos booleanVideo Cts 
- Trust the QoS marking of the Cisco Telepresence System
- autoQos booleanVideo Ip Camera 
- Trust the QoS marking of the Ip Video Surveillance camera
- autoQos booleanVideo Media Player 
- Trust the Qos marking of the Cisco Media Player
- autoQos booleanVoip 
- Configure AutoQoS for VoIP
- autoQos booleanVoip Cisco Phone 
- Trust the QoS marking of Cisco IP Phone
- autoQos booleanVoip Cisco Softphone 
- Trust the QoS marking of Cisco IP SoftPhone
- autoQos booleanVoip Trust 
- Trust the DSCP/CoS marking
- bfdEcho boolean
- Use echo adjunct as bfd detection mechanism
- bfdEnable boolean
- Enable BFD under the interface
- bfdInterval number
- bfdInterval numberMin Rx 
- Minimum receive interval capability
- bfdInterval numberMultiplier 
- Multiplier value used to compute holddown
- bfdLocal stringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate string
- BFD template
- description string
- Interface specific description
- helperAddresses GetInterface Port Channel Helper Address[] 
- Specify a destination address for UDP broadcasts
- id string
- The path of the retrieved object.
- ipAccess stringGroup In 
- ipAccess booleanGroup In Enable 
- inbound packets
- ipAccess stringGroup Out 
- ipAccess booleanGroup Out Enable 
- outbound packets
- ipArp numberInspection Limit Rate 
- Rate Limit
- ipArp booleanInspection Trust 
- Configure Trust state
- ipDhcp stringRelay Source Interface 
- Set source interface for relayed messages
- ipDhcp booleanSnooping Trust 
- DHCP Snooping trust config
- ipProxy booleanArp 
- Enable proxy ARP
- ipRedirects boolean
- Enable sending ICMP Redirect messages
- ipUnreachables boolean
- Enable sending ICMP Unreachable messages
- ipv4Address string
- ipv4AddressMask string
- ipv6AddressAutoconfig booleanDefault 
- Insert default route
- ipv6AddressDhcp boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses
GetInterface Port Channel Ipv6Address[] 
- ipv6Enable boolean
- Enable IPv6 on interface
- ipv6LinkLocal GetAddresses Interface Port Channel Ipv6Link Local Address[] 
- ipv6Mtu number
- Set IPv6 Maximum Transmission Unit
- ipv6NdRa booleanSuppress All 
- Suppress all IPv6 RA
- name number
- shutdown boolean
- Shutdown the selected interface
- spanningTree stringGuard 
- Change an interface's spanning tree guard mode
- spanningTree stringLink Type 
- Specify a link type for spanning tree tree protocol use
- switchport boolean
- trustDevice string
- trusted device class
- vrfForwarding string
- Configure forwarding table
- device string
- A device name from the provider configuration.
- arp_timeout int
- Set ARP cache timeout
- auto_qos_ boolclassify 
- Configure classification for untrusted devices
- auto_qos_ boolclassify_ police 
- Configure QoS policing for untrusted devices
- auto_qos_ booltrust 
- Trust the DSCP/CoS marking
- auto_qos_ booltrust_ cos 
- Trust the CoS marking
- auto_qos_ booltrust_ dscp 
- Trust the DSCP marking
- auto_qos_ boolvideo_ cts 
- Trust the QoS marking of the Cisco Telepresence System
- auto_qos_ boolvideo_ ip_ camera 
- Trust the QoS marking of the Ip Video Surveillance camera
- auto_qos_ boolvideo_ media_ player 
- Trust the Qos marking of the Cisco Media Player
- auto_qos_ boolvoip 
- Configure AutoQoS for VoIP
- auto_qos_ boolvoip_ cisco_ phone 
- Trust the QoS marking of Cisco IP Phone
- auto_qos_ boolvoip_ cisco_ softphone 
- Trust the QoS marking of Cisco IP SoftPhone
- auto_qos_ boolvoip_ trust 
- Trust the DSCP/CoS marking
- bfd_echo bool
- Use echo adjunct as bfd detection mechanism
- bfd_enable bool
- Enable BFD under the interface
- bfd_interval int
- bfd_interval_ intmin_ rx 
- Minimum receive interval capability
- bfd_interval_ intmultiplier 
- Multiplier value used to compute holddown
- bfd_local_ straddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfd_template str
- BFD template
- description str
- Interface specific description
- helper_addresses Sequence[GetInterface Port Channel Helper Address] 
- Specify a destination address for UDP broadcasts
- id str
- The path of the retrieved object.
- ip_access_ strgroup_ in 
- ip_access_ boolgroup_ in_ enable 
- inbound packets
- ip_access_ strgroup_ out 
- ip_access_ boolgroup_ out_ enable 
- outbound packets
- ip_arp_ intinspection_ limit_ rate 
- Rate Limit
- ip_arp_ boolinspection_ trust 
- Configure Trust state
- ip_dhcp_ strrelay_ source_ interface 
- Set source interface for relayed messages
- ip_dhcp_ boolsnooping_ trust 
- DHCP Snooping trust config
- ip_proxy_ boolarp 
- Enable proxy ARP
- ip_redirects bool
- Enable sending ICMP Redirect messages
- ip_unreachables bool
- Enable sending ICMP Unreachable messages
- ipv4_address str
- ipv4_address_ strmask 
- ipv6_address_ boolautoconfig_ default 
- Insert default route
- ipv6_address_ booldhcp 
- Obtain IPv6 address from DHCP server
- ipv6_addresses Sequence[GetInterface Port Channel Ipv6Address] 
- ipv6_enable bool
- Enable IPv6 on interface
- ipv6_link_ Sequence[Getlocal_ addresses Interface Port Channel Ipv6Link Local Address] 
- ipv6_mtu int
- Set IPv6 Maximum Transmission Unit
- ipv6_nd_ boolra_ suppress_ all 
- Suppress all IPv6 RA
- name int
- shutdown bool
- Shutdown the selected interface
- spanning_tree_ strguard 
- Change an interface's spanning tree guard mode
- spanning_tree_ strlink_ type 
- Specify a link type for spanning tree tree protocol use
- switchport bool
- trust_device str
- trusted device class
- vrf_forwarding str
- Configure forwarding table
- device str
- A device name from the provider configuration.
- arpTimeout Number
- Set ARP cache timeout
- autoQos BooleanClassify 
- Configure classification for untrusted devices
- autoQos BooleanClassify Police 
- Configure QoS policing for untrusted devices
- autoQos BooleanTrust 
- Trust the DSCP/CoS marking
- autoQos BooleanTrust Cos 
- Trust the CoS marking
- autoQos BooleanTrust Dscp 
- Trust the DSCP marking
- autoQos BooleanVideo Cts 
- Trust the QoS marking of the Cisco Telepresence System
- autoQos BooleanVideo Ip Camera 
- Trust the QoS marking of the Ip Video Surveillance camera
- autoQos BooleanVideo Media Player 
- Trust the Qos marking of the Cisco Media Player
- autoQos BooleanVoip 
- Configure AutoQoS for VoIP
- autoQos BooleanVoip Cisco Phone 
- Trust the QoS marking of Cisco IP Phone
- autoQos BooleanVoip Cisco Softphone 
- Trust the QoS marking of Cisco IP SoftPhone
- autoQos BooleanVoip Trust 
- Trust the DSCP/CoS marking
- bfdEcho Boolean
- Use echo adjunct as bfd detection mechanism
- bfdEnable Boolean
- Enable BFD under the interface
- bfdInterval Number
- bfdInterval NumberMin Rx 
- Minimum receive interval capability
- bfdInterval NumberMultiplier 
- Multiplier value used to compute holddown
- bfdLocal StringAddress 
- The Source IP address to be used for BFD sessions over this interface.
- bfdTemplate String
- BFD template
- description String
- Interface specific description
- helperAddresses List<Property Map>
- Specify a destination address for UDP broadcasts
- id String
- The path of the retrieved object.
- ipAccess StringGroup In 
- ipAccess BooleanGroup In Enable 
- inbound packets
- ipAccess StringGroup Out 
- ipAccess BooleanGroup Out Enable 
- outbound packets
- ipArp NumberInspection Limit Rate 
- Rate Limit
- ipArp BooleanInspection Trust 
- Configure Trust state
- ipDhcp StringRelay Source Interface 
- Set source interface for relayed messages
- ipDhcp BooleanSnooping Trust 
- DHCP Snooping trust config
- ipProxy BooleanArp 
- Enable proxy ARP
- ipRedirects Boolean
- Enable sending ICMP Redirect messages
- ipUnreachables Boolean
- Enable sending ICMP Unreachable messages
- ipv4Address String
- ipv4AddressMask String
- ipv6AddressAutoconfig BooleanDefault 
- Insert default route
- ipv6AddressDhcp Boolean
- Obtain IPv6 address from DHCP server
- ipv6Addresses List<Property Map>
- ipv6Enable Boolean
- Enable IPv6 on interface
- ipv6LinkLocal List<Property Map>Addresses 
- ipv6Mtu Number
- Set IPv6 Maximum Transmission Unit
- ipv6NdRa BooleanSuppress All 
- Suppress all IPv6 RA
- name Number
- shutdown Boolean
- Shutdown the selected interface
- spanningTree StringGuard 
- Change an interface's spanning tree guard mode
- spanningTree StringLink Type 
- Specify a link type for spanning tree tree protocol use
- switchport Boolean
- trustDevice String
- trusted device class
- vrfForwarding String
- Configure forwarding table
- device String
- A device name from the provider configuration.
Supporting Types
GetInterfacePortChannelHelperAddress     
GetInterfacePortChannelIpv6Address    
GetInterfacePortChannelIpv6LinkLocalAddress      
- address str
- link_local bool
- Use link-local address
Package Details
- Repository
- iosxe lbrlabs/pulumi-iosxe
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the iosxeTerraform Provider.