1. Packages
  2. Linode Provider
  3. API Docs
  4. getInterface
Viewing docs for Linode v5.9.0
published on Friday, Mar 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-linode

linode.getInterface

linode logo
Viewing docs for Linode v5.9.0
published on Friday, Mar 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-linode

    Using getInterface

    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 getInterface(args: GetInterfaceArgs, opts?: InvokeOptions): Promise<GetInterfaceResult>
function getInterfaceOutput(args: GetInterfaceOutputArgs, opts?: InvokeOptions): Output<GetInterfaceResult>
    def get_interface(id: Optional[str] = None,
                  linode_id: Optional[int] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInterfaceResult
def get_interface_output(id: Optional[pulumi.Input[str]] = None,
                  linode_id: Optional[pulumi.Input[int]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceResult]
    func LookupInterface(ctx *Context, args *LookupInterfaceArgs, opts ...InvokeOption) (*LookupInterfaceResult, error)
func LookupInterfaceOutput(ctx *Context, args *LookupInterfaceOutputArgs, opts ...InvokeOption) LookupInterfaceResultOutput

    > Note: This function is named LookupInterface in the Go SDK.

    public static class GetInterface 
{
    public static Task<GetInterfaceResult> InvokeAsync(GetInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfaceResult> Invoke(GetInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInterfaceResult> getInterface(GetInterfaceArgs args, InvokeOptions options)
public static Output<GetInterfaceResult> getInterface(GetInterfaceArgs args, InvokeOptions options)

    fn::invoke:
  function: linode:index/getInterface:getInterface
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    LinodeId int
    Id string
    LinodeId int
    id String
    linodeId Integer
    id string
    linodeId number
    id str
    linode_id int
    id String
    linodeId Number

    getInterface Result

    The following output properties are available:

    Supporting Types

    GetInterfaceDefaultRoute

    Ipv4 bool
    Whether this interface is used for the IPv4 default route.
    Ipv6 bool
    Whether this interface is used for the IPv6 default route.
    Ipv4 bool
    Whether this interface is used for the IPv4 default route.
    Ipv6 bool
    Whether this interface is used for the IPv6 default route.
    ipv4 Boolean
    Whether this interface is used for the IPv4 default route.
    ipv6 Boolean
    Whether this interface is used for the IPv6 default route.
    ipv4 boolean
    Whether this interface is used for the IPv4 default route.
    ipv6 boolean
    Whether this interface is used for the IPv6 default route.
    ipv4 bool
    Whether this interface is used for the IPv4 default route.
    ipv6 bool
    Whether this interface is used for the IPv6 default route.
    ipv4 Boolean
    Whether this interface is used for the IPv4 default route.
    ipv6 Boolean
    Whether this interface is used for the IPv6 default route.

    GetInterfacePublic

    Ipv4 GetInterfacePublicIpv4
    The public IPv4 configuration for the interface.
    Ipv6 GetInterfacePublicIpv6
    The public IPv6 configuration for the interface.
    Ipv4 GetInterfacePublicIpv4
    The public IPv4 configuration for the interface.
    Ipv6 GetInterfacePublicIpv6
    The public IPv6 configuration for the interface.
    ipv4 GetInterfacePublicIpv4
    The public IPv4 configuration for the interface.
    ipv6 GetInterfacePublicIpv6
    The public IPv6 configuration for the interface.
    ipv4 GetInterfacePublicIpv4
    The public IPv4 configuration for the interface.
    ipv6 GetInterfacePublicIpv6
    The public IPv6 configuration for the interface.
    ipv4 GetInterfacePublicIpv4
    The public IPv4 configuration for the interface.
    ipv6 GetInterfacePublicIpv6
    The public IPv6 configuration for the interface.
    ipv4 Property Map
    The public IPv4 configuration for the interface.
    ipv6 Property Map
    The public IPv6 configuration for the interface.

    GetInterfacePublicIpv4

    Addresses List<GetInterfacePublicIpv4Address>
    IPv4 addresses assigned to this interface.
    Shareds List<GetInterfacePublicIpv4Shared>
    IPv4 addresses shared with other Linodes.
    Addresses []GetInterfacePublicIpv4Address
    IPv4 addresses assigned to this interface.
    Shareds []GetInterfacePublicIpv4Shared
    IPv4 addresses shared with other Linodes.
    addresses List<GetInterfacePublicIpv4Address>
    IPv4 addresses assigned to this interface.
    shareds List<GetInterfacePublicIpv4Shared>
    IPv4 addresses shared with other Linodes.
    addresses GetInterfacePublicIpv4Address[]
    IPv4 addresses assigned to this interface.
    shareds GetInterfacePublicIpv4Shared[]
    IPv4 addresses shared with other Linodes.
    addresses Sequence[GetInterfacePublicIpv4Address]
    IPv4 addresses assigned to this interface.
    shareds Sequence[GetInterfacePublicIpv4Shared]
    IPv4 addresses shared with other Linodes.
    addresses List<Property Map>
    IPv4 addresses assigned to this interface.
    shareds List<Property Map>
    IPv4 addresses shared with other Linodes.

    GetInterfacePublicIpv4Address

    Address string
    The IPv4 address.
    Primary bool
    Whether this is the primary IPv4 address.
    Address string
    The IPv4 address.
    Primary bool
    Whether this is the primary IPv4 address.
    address String
    The IPv4 address.
    primary Boolean
    Whether this is the primary IPv4 address.
    address string
    The IPv4 address.
    primary boolean
    Whether this is the primary IPv4 address.
    address str
    The IPv4 address.
    primary bool
    Whether this is the primary IPv4 address.
    address String
    The IPv4 address.
    primary Boolean
    Whether this is the primary IPv4 address.

    GetInterfacePublicIpv4Shared

    Address string
    The shared IPv4 address.
    LinodeId int
    The ID of the Linode that this shared address belongs to.
    Address string
    The shared IPv4 address.
    LinodeId int
    The ID of the Linode that this shared address belongs to.
    address String
    The shared IPv4 address.
    linodeId Integer
    The ID of the Linode that this shared address belongs to.
    address string
    The shared IPv4 address.
    linodeId number
    The ID of the Linode that this shared address belongs to.
    address str
    The shared IPv4 address.
    linode_id int
    The ID of the Linode that this shared address belongs to.
    address String
    The shared IPv4 address.
    linodeId Number
    The ID of the Linode that this shared address belongs to.

    GetInterfacePublicIpv6

    Ranges List<GetInterfacePublicIpv6Range>
    IPv6 ranges assigned to this interface.
    Shareds List<GetInterfacePublicIpv6Shared>
    IPv6 ranges shared with other Linodes.
    Slaacs List<GetInterfacePublicIpv6Slaac>
    IPv6 SLAAC configuration.
    Ranges []GetInterfacePublicIpv6Range
    IPv6 ranges assigned to this interface.
    Shareds []GetInterfacePublicIpv6Shared
    IPv6 ranges shared with other Linodes.
    Slaacs []GetInterfacePublicIpv6Slaac
    IPv6 SLAAC configuration.
    ranges List<GetInterfacePublicIpv6Range>
    IPv6 ranges assigned to this interface.
    shareds List<GetInterfacePublicIpv6Shared>
    IPv6 ranges shared with other Linodes.
    slaacs List<GetInterfacePublicIpv6Slaac>
    IPv6 SLAAC configuration.
    ranges GetInterfacePublicIpv6Range[]
    IPv6 ranges assigned to this interface.
    shareds GetInterfacePublicIpv6Shared[]
    IPv6 ranges shared with other Linodes.
    slaacs GetInterfacePublicIpv6Slaac[]
    IPv6 SLAAC configuration.
    ranges Sequence[GetInterfacePublicIpv6Range]
    IPv6 ranges assigned to this interface.
    shareds Sequence[GetInterfacePublicIpv6Shared]
    IPv6 ranges shared with other Linodes.
    slaacs Sequence[GetInterfacePublicIpv6Slaac]
    IPv6 SLAAC configuration.
    ranges List<Property Map>
    IPv6 ranges assigned to this interface.
    shareds List<Property Map>
    IPv6 ranges shared with other Linodes.
    slaacs List<Property Map>
    IPv6 SLAAC configuration.

    GetInterfacePublicIpv6Range

    Range string
    The IPv6 range.
    RouteTarget string
    The route target for this IPv6 range.
    Range string
    The IPv6 range.
    RouteTarget string
    The route target for this IPv6 range.
    range String
    The IPv6 range.
    routeTarget String
    The route target for this IPv6 range.
    range string
    The IPv6 range.
    routeTarget string
    The route target for this IPv6 range.
    range str
    The IPv6 range.
    route_target str
    The route target for this IPv6 range.
    range String
    The IPv6 range.
    routeTarget String
    The route target for this IPv6 range.

    GetInterfacePublicIpv6Shared

    Range string
    The IPv6 range.
    RouteTarget string
    The route target for this IPv6 range.
    Range string
    The IPv6 range.
    RouteTarget string
    The route target for this IPv6 range.
    range String
    The IPv6 range.
    routeTarget String
    The route target for this IPv6 range.
    range string
    The IPv6 range.
    routeTarget string
    The route target for this IPv6 range.
    range str
    The IPv6 range.
    route_target str
    The route target for this IPv6 range.
    range String
    The IPv6 range.
    routeTarget String
    The route target for this IPv6 range.

    GetInterfacePublicIpv6Slaac

    Address string
    The IPv6 SLAAC address.
    Prefix int
    The prefix length for the IPv6 SLAAC address.
    Address string
    The IPv6 SLAAC address.
    Prefix int
    The prefix length for the IPv6 SLAAC address.
    address String
    The IPv6 SLAAC address.
    prefix Integer
    The prefix length for the IPv6 SLAAC address.
    address string
    The IPv6 SLAAC address.
    prefix number
    The prefix length for the IPv6 SLAAC address.
    address str
    The IPv6 SLAAC address.
    prefix int
    The prefix length for the IPv6 SLAAC address.
    address String
    The IPv6 SLAAC address.
    prefix Number
    The prefix length for the IPv6 SLAAC address.

    GetInterfaceVlan

    IpamAddress string
    The IPAM (IP Address Management) address of the VLAN interface.
    VlanLabel string
    The label of the VLAN.
    IpamAddress string
    The IPAM (IP Address Management) address of the VLAN interface.
    VlanLabel string
    The label of the VLAN.
    ipamAddress String
    The IPAM (IP Address Management) address of the VLAN interface.
    vlanLabel String
    The label of the VLAN.
    ipamAddress string
    The IPAM (IP Address Management) address of the VLAN interface.
    vlanLabel string
    The label of the VLAN.
    ipam_address str
    The IPAM (IP Address Management) address of the VLAN interface.
    vlan_label str
    The label of the VLAN.
    ipamAddress String
    The IPAM (IP Address Management) address of the VLAN interface.
    vlanLabel String
    The label of the VLAN.

    GetInterfaceVpc

    Ipv4 GetInterfaceVpcIpv4
    The IPv4 configuration for the VPC interface.
    Ipv6 GetInterfaceVpcIpv6
    The IPv6 configuration for the VPC interface.
    SubnetId int
    The ID of the VPC subnet.
    Ipv4 GetInterfaceVpcIpv4
    The IPv4 configuration for the VPC interface.
    Ipv6 GetInterfaceVpcIpv6
    The IPv6 configuration for the VPC interface.
    SubnetId int
    The ID of the VPC subnet.
    ipv4 GetInterfaceVpcIpv4
    The IPv4 configuration for the VPC interface.
    ipv6 GetInterfaceVpcIpv6
    The IPv6 configuration for the VPC interface.
    subnetId Integer
    The ID of the VPC subnet.
    ipv4 GetInterfaceVpcIpv4
    The IPv4 configuration for the VPC interface.
    ipv6 GetInterfaceVpcIpv6
    The IPv6 configuration for the VPC interface.
    subnetId number
    The ID of the VPC subnet.
    ipv4 GetInterfaceVpcIpv4
    The IPv4 configuration for the VPC interface.
    ipv6 GetInterfaceVpcIpv6
    The IPv6 configuration for the VPC interface.
    subnet_id int
    The ID of the VPC subnet.
    ipv4 Property Map
    The IPv4 configuration for the VPC interface.
    ipv6 Property Map
    The IPv6 configuration for the VPC interface.
    subnetId Number
    The ID of the VPC subnet.

    GetInterfaceVpcIpv4

    Addresses List<GetInterfaceVpcIpv4Address>
    IPv4 addresses assigned to this VPC interface.
    Ranges List<GetInterfaceVpcIpv4Range>
    IPv4 ranges assigned to this VPC interface.
    Addresses []GetInterfaceVpcIpv4Address
    IPv4 addresses assigned to this VPC interface.
    Ranges []GetInterfaceVpcIpv4Range
    IPv4 ranges assigned to this VPC interface.
    addresses List<GetInterfaceVpcIpv4Address>
    IPv4 addresses assigned to this VPC interface.
    ranges List<GetInterfaceVpcIpv4Range>
    IPv4 ranges assigned to this VPC interface.
    addresses GetInterfaceVpcIpv4Address[]
    IPv4 addresses assigned to this VPC interface.
    ranges GetInterfaceVpcIpv4Range[]
    IPv4 ranges assigned to this VPC interface.
    addresses Sequence[GetInterfaceVpcIpv4Address]
    IPv4 addresses assigned to this VPC interface.
    ranges Sequence[GetInterfaceVpcIpv4Range]
    IPv4 ranges assigned to this VPC interface.
    addresses List<Property Map>
    IPv4 addresses assigned to this VPC interface.
    ranges List<Property Map>
    IPv4 ranges assigned to this VPC interface.

    GetInterfaceVpcIpv4Address

    Address string
    The VPC IPv4 address.
    Nat11Address string
    The 1:1 NAT address for this VPC IPv4 address.
    Primary bool
    Whether this is the primary VPC IPv4 address.
    Address string
    The VPC IPv4 address.
    Nat11Address string
    The 1:1 NAT address for this VPC IPv4 address.
    Primary bool
    Whether this is the primary VPC IPv4 address.
    address String
    The VPC IPv4 address.
    nat11Address String
    The 1:1 NAT address for this VPC IPv4 address.
    primary Boolean
    Whether this is the primary VPC IPv4 address.
    address string
    The VPC IPv4 address.
    nat11Address string
    The 1:1 NAT address for this VPC IPv4 address.
    primary boolean
    Whether this is the primary VPC IPv4 address.
    address str
    The VPC IPv4 address.
    nat11_address str
    The 1:1 NAT address for this VPC IPv4 address.
    primary bool
    Whether this is the primary VPC IPv4 address.
    address String
    The VPC IPv4 address.
    nat11Address String
    The 1:1 NAT address for this VPC IPv4 address.
    primary Boolean
    Whether this is the primary VPC IPv4 address.

    GetInterfaceVpcIpv4Range

    Range string
    The VPC IPv4 range.
    Range string
    The VPC IPv4 range.
    range String
    The VPC IPv4 range.
    range string
    The VPC IPv4 range.
    range str
    The VPC IPv4 range.
    range String
    The VPC IPv4 range.

    GetInterfaceVpcIpv6

    IsPublic bool
    Indicates whether the IPv6 configuration on the Linode interface is public.
    Ranges List<GetInterfaceVpcIpv6Range>
    IPv6 ranges assigned to this VPC interface.
    Slaacs List<GetInterfaceVpcIpv6Slaac>
    IPv6 SLAAC address ranges.
    IsPublic bool
    Indicates whether the IPv6 configuration on the Linode interface is public.
    Ranges []GetInterfaceVpcIpv6Range
    IPv6 ranges assigned to this VPC interface.
    Slaacs []GetInterfaceVpcIpv6Slaac
    IPv6 SLAAC address ranges.
    isPublic Boolean
    Indicates whether the IPv6 configuration on the Linode interface is public.
    ranges List<GetInterfaceVpcIpv6Range>
    IPv6 ranges assigned to this VPC interface.
    slaacs List<GetInterfaceVpcIpv6Slaac>
    IPv6 SLAAC address ranges.
    isPublic boolean
    Indicates whether the IPv6 configuration on the Linode interface is public.
    ranges GetInterfaceVpcIpv6Range[]
    IPv6 ranges assigned to this VPC interface.
    slaacs GetInterfaceVpcIpv6Slaac[]
    IPv6 SLAAC address ranges.
    is_public bool
    Indicates whether the IPv6 configuration on the Linode interface is public.
    ranges Sequence[GetInterfaceVpcIpv6Range]
    IPv6 ranges assigned to this VPC interface.
    slaacs Sequence[GetInterfaceVpcIpv6Slaac]
    IPv6 SLAAC address ranges.
    isPublic Boolean
    Indicates whether the IPv6 configuration on the Linode interface is public.
    ranges List<Property Map>
    IPv6 ranges assigned to this VPC interface.
    slaacs List<Property Map>
    IPv6 SLAAC address ranges.

    GetInterfaceVpcIpv6Range

    Range string
    The IPv6 network range in CIDR notation.
    Range string
    The IPv6 network range in CIDR notation.
    range String
    The IPv6 network range in CIDR notation.
    range string
    The IPv6 network range in CIDR notation.
    range str
    The IPv6 network range in CIDR notation.
    range String
    The IPv6 network range in CIDR notation.

    GetInterfaceVpcIpv6Slaac

    Address string
    The assigned IPv6 address within the range.
    Range string
    The IPv6 network range in CIDR notation.
    Address string
    The assigned IPv6 address within the range.
    Range string
    The IPv6 network range in CIDR notation.
    address String
    The assigned IPv6 address within the range.
    range String
    The IPv6 network range in CIDR notation.
    address string
    The assigned IPv6 address within the range.
    range string
    The IPv6 network range in CIDR notation.
    address str
    The assigned IPv6 address within the range.
    range str
    The IPv6 network range in CIDR notation.
    address String
    The assigned IPv6 address within the range.
    range String
    The IPv6 network range in CIDR notation.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Viewing docs for Linode v5.9.0
    published on Friday, Mar 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-linode
      Try Pulumi Cloud free. Your team will thank you.