1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getWirelessLink
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.0
published on Wednesday, Nov 4, 2026 by e-breuninger

    A wireless link between two wireless interfaces (wireless.wirelesslink).

    From the official documentation:

    A wireless link represents a connection between exactly two wireless interfaces. Unlike a wireless LAN, which permit an arbitrary number of client associations, wireless links are used to model point-to-point wireless connections.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getWirelessLink({
        id: 123,
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_wireless_link(id=123)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v6/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.LookupWirelessLink(ctx, &netbox.LookupWirelessLinkArgs{
    			Id: pulumi.Float64Ref(123),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Netbox.GetWirelessLink.Invoke(new()
        {
            Id = 123,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.NetboxFunctions;
    import com.pulumi.netbox.inputs.GetWirelessLinkArgs;
    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 test = NetboxFunctions.getWirelessLink(GetWirelessLinkArgs.builder()
                .id(123)
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getWirelessLink
          arguments:
            id: 123
    
    Example coming soon!
    

    Using getWirelessLink

    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 getWirelessLink(args: GetWirelessLinkArgs, opts?: InvokeOptions): Promise<GetWirelessLinkResult>
    function getWirelessLinkOutput(args: GetWirelessLinkOutputArgs, opts?: InvokeOutputOptions): Output<GetWirelessLinkResult>
    def get_wireless_link(custom_field_filters: Optional[Mapping[str, str]] = None,
                          id: Optional[float] = None,
                          interface_a_id: Optional[float] = None,
                          interface_b_id: Optional[float] = None,
                          owner_id: Optional[float] = None,
                          ssid: Optional[str] = None,
                          status: Optional[str] = None,
                          tag_slug: Optional[str] = None,
                          tenant_id: Optional[float] = None,
                          opts: Optional[InvokeOptions] = None) -> GetWirelessLinkResult
    def get_wireless_link_output(custom_field_filters: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                          id: pulumi.Input[Optional[float]] = None,
                          interface_a_id: pulumi.Input[Optional[float]] = None,
                          interface_b_id: pulumi.Input[Optional[float]] = None,
                          owner_id: pulumi.Input[Optional[float]] = None,
                          ssid: pulumi.Input[Optional[str]] = None,
                          status: pulumi.Input[Optional[str]] = None,
                          tag_slug: pulumi.Input[Optional[str]] = None,
                          tenant_id: pulumi.Input[Optional[float]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetWirelessLinkResult]
    func LookupWirelessLink(ctx *Context, args *LookupWirelessLinkArgs, opts ...InvokeOption) (*LookupWirelessLinkResult, error)
    func LookupWirelessLinkOutput(ctx *Context, args *LookupWirelessLinkOutputArgs, opts ...InvokeOption) LookupWirelessLinkResultOutput

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

    public static class GetWirelessLink 
    {
        public static Task<GetWirelessLinkResult> InvokeAsync(GetWirelessLinkArgs args, InvokeOptions? opts = null)
        public static Output<GetWirelessLinkResult> Invoke(GetWirelessLinkInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetWirelessLinkResult> Invoke(GetWirelessLinkInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetWirelessLinkResult> getWirelessLink(GetWirelessLinkArgs args, InvokeOptions options)
    public static Output<GetWirelessLinkResult> getWirelessLink(GetWirelessLinkArgs args, InvokeOptions options)
    public static Output<GetWirelessLinkResult> getWirelessLink(GetWirelessLinkArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getWirelessLink:getWirelessLink
      arguments:
        # arguments dictionary
    data "netbox_get_wireless_link" "name" {
        # arguments
    }

    The following arguments are supported:

    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    Id double
    NetBox id.
    InterfaceAId double
    Id of the first interface; it must be of a wireless type.
    InterfaceBId double
    Id of the second interface; it must be of a wireless type.
    OwnerId double
    Id of the owner the object is assigned to.
    Ssid string
    Service set identifier.
    Status string
    Link status. One of: connected, planned, decommissioning.
    TagSlug string
    Slug of a tag the object carries.
    TenantId double
    Id of the tenant.
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    Id float64
    NetBox id.
    InterfaceAId float64
    Id of the first interface; it must be of a wireless type.
    InterfaceBId float64
    Id of the second interface; it must be of a wireless type.
    OwnerId float64
    Id of the owner the object is assigned to.
    Ssid string
    Service set identifier.
    Status string
    Link status. One of: connected, planned, decommissioning.
    TagSlug string
    Slug of a tag the object carries.
    TenantId float64
    Id of the tenant.
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    id number
    NetBox id.
    interface_a_id number
    Id of the first interface; it must be of a wireless type.
    interface_b_id number
    Id of the second interface; it must be of a wireless type.
    owner_id number
    Id of the owner the object is assigned to.
    ssid string
    Service set identifier.
    status string
    Link status. One of: connected, planned, decommissioning.
    tag_slug string
    Slug of a tag the object carries.
    tenant_id number
    Id of the tenant.
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    id Double
    NetBox id.
    interfaceAId Double
    Id of the first interface; it must be of a wireless type.
    interfaceBId Double
    Id of the second interface; it must be of a wireless type.
    ownerId Double
    Id of the owner the object is assigned to.
    ssid String
    Service set identifier.
    status String
    Link status. One of: connected, planned, decommissioning.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Double
    Id of the tenant.
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    id number
    NetBox id.
    interfaceAId number
    Id of the first interface; it must be of a wireless type.
    interfaceBId number
    Id of the second interface; it must be of a wireless type.
    ownerId number
    Id of the owner the object is assigned to.
    ssid string
    Service set identifier.
    status string
    Link status. One of: connected, planned, decommissioning.
    tagSlug string
    Slug of a tag the object carries.
    tenantId number
    Id of the tenant.
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    id float
    NetBox id.
    interface_a_id float
    Id of the first interface; it must be of a wireless type.
    interface_b_id float
    Id of the second interface; it must be of a wireless type.
    owner_id float
    Id of the owner the object is assigned to.
    ssid str
    Service set identifier.
    status str
    Link status. One of: connected, planned, decommissioning.
    tag_slug str
    Slug of a tag the object carries.
    tenant_id float
    Id of the tenant.
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    id Number
    NetBox id.
    interfaceAId Number
    Id of the first interface; it must be of a wireless type.
    interfaceBId Number
    Id of the second interface; it must be of a wireless type.
    ownerId Number
    Id of the owner the object is assigned to.
    ssid String
    Service set identifier.
    status String
    Link status. One of: connected, planned, decommissioning.
    tagSlug String
    Slug of a tag the object carries.
    tenantId Number
    Id of the tenant.

    getWirelessLink Result

    The following output properties are available:

    AuthCipher string
    Authentication cipher. One of: auto, tkip, aes.
    AuthPsk string
    Pre-shared key.
    AuthType string
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    Comments string
    Created string
    CustomFields Dictionary<string, string>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    Distance double
    Link distance; requires distance_unit.
    DistanceUnit string
    Unit of distance. One of: km, m, mi, ft.
    Id double
    NetBox id.
    InterfaceAId double
    Id of the first interface; it must be of a wireless type.
    InterfaceBId double
    Id of the second interface; it must be of a wireless type.
    LastUpdated string
    OwnerId double
    Id of the owner the object is assigned to.
    Ssid string
    Service set identifier.
    Status string
    Link status. One of: connected, planned, decommissioning.
    Tags List<string>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls List<string>
    Slugs of all tags on the object, including the provider's default_tags.
    TenantId double
    Id of the tenant.
    Url string
    CustomFieldFilters Dictionary<string, string>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    TagSlug string
    Slug of a tag the object carries.
    AuthCipher string
    Authentication cipher. One of: auto, tkip, aes.
    AuthPsk string
    Pre-shared key.
    AuthType string
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    Comments string
    Created string
    CustomFields map[string]string
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    Description string
    Distance float64
    Link distance; requires distance_unit.
    DistanceUnit string
    Unit of distance. One of: km, m, mi, ft.
    Id float64
    NetBox id.
    InterfaceAId float64
    Id of the first interface; it must be of a wireless type.
    InterfaceBId float64
    Id of the second interface; it must be of a wireless type.
    LastUpdated string
    OwnerId float64
    Id of the owner the object is assigned to.
    Ssid string
    Service set identifier.
    Status string
    Link status. One of: connected, planned, decommissioning.
    Tags []string
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    TagsAlls []string
    Slugs of all tags on the object, including the provider's default_tags.
    TenantId float64
    Id of the tenant.
    Url string
    CustomFieldFilters map[string]string
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    TagSlug string
    Slug of a tag the object carries.
    auth_cipher string
    Authentication cipher. One of: auto, tkip, aes.
    auth_psk string
    Pre-shared key.
    auth_type string
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    comments string
    created string
    custom_fields map(string)
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    distance number
    Link distance; requires distance_unit.
    distance_unit string
    Unit of distance. One of: km, m, mi, ft.
    id number
    NetBox id.
    interface_a_id number
    Id of the first interface; it must be of a wireless type.
    interface_b_id number
    Id of the second interface; it must be of a wireless type.
    last_updated string
    owner_id number
    Id of the owner the object is assigned to.
    ssid string
    Service set identifier.
    status string
    Link status. One of: connected, planned, decommissioning.
    tags list(string)
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls list(string)
    Slugs of all tags on the object, including the provider's default_tags.
    tenant_id number
    Id of the tenant.
    url string
    custom_field_filters map(string)
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tag_slug string
    Slug of a tag the object carries.
    authCipher String
    Authentication cipher. One of: auto, tkip, aes.
    authPsk String
    Pre-shared key.
    authType String
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    comments String
    created String
    customFields Map<String,String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    distance Double
    Link distance; requires distance_unit.
    distanceUnit String
    Unit of distance. One of: km, m, mi, ft.
    id Double
    NetBox id.
    interfaceAId Double
    Id of the first interface; it must be of a wireless type.
    interfaceBId Double
    Id of the second interface; it must be of a wireless type.
    lastUpdated String
    ownerId Double
    Id of the owner the object is assigned to.
    ssid String
    Service set identifier.
    status String
    Link status. One of: connected, planned, decommissioning.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    tenantId Double
    Id of the tenant.
    url String
    customFieldFilters Map<String,String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tagSlug String
    Slug of a tag the object carries.
    authCipher string
    Authentication cipher. One of: auto, tkip, aes.
    authPsk string
    Pre-shared key.
    authType string
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    comments string
    created string
    customFields {[key: string]: string}
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description string
    distance number
    Link distance; requires distance_unit.
    distanceUnit string
    Unit of distance. One of: km, m, mi, ft.
    id number
    NetBox id.
    interfaceAId number
    Id of the first interface; it must be of a wireless type.
    interfaceBId number
    Id of the second interface; it must be of a wireless type.
    lastUpdated string
    ownerId number
    Id of the owner the object is assigned to.
    ssid string
    Service set identifier.
    status string
    Link status. One of: connected, planned, decommissioning.
    tags string[]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls string[]
    Slugs of all tags on the object, including the provider's default_tags.
    tenantId number
    Id of the tenant.
    url string
    customFieldFilters {[key: string]: string}
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tagSlug string
    Slug of a tag the object carries.
    auth_cipher str
    Authentication cipher. One of: auto, tkip, aes.
    auth_psk str
    Pre-shared key.
    auth_type str
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    comments str
    created str
    custom_fields Mapping[str, str]
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description str
    distance float
    Link distance; requires distance_unit.
    distance_unit str
    Unit of distance. One of: km, m, mi, ft.
    id float
    NetBox id.
    interface_a_id float
    Id of the first interface; it must be of a wireless type.
    interface_b_id float
    Id of the second interface; it must be of a wireless type.
    last_updated str
    owner_id float
    Id of the owner the object is assigned to.
    ssid str
    Service set identifier.
    status str
    Link status. One of: connected, planned, decommissioning.
    tags Sequence[str]
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tags_alls Sequence[str]
    Slugs of all tags on the object, including the provider's default_tags.
    tenant_id float
    Id of the tenant.
    url str
    custom_field_filters Mapping[str, str]
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tag_slug str
    Slug of a tag the object carries.
    authCipher String
    Authentication cipher. One of: auto, tkip, aes.
    authPsk String
    Pre-shared key.
    authType String
    Authentication type. One of: open, wep, wpa-personal, wpa-enterprise.
    comments String
    created String
    customFields Map<String>
    Custom field values by field name. Every value is a string; NetBox coerces numbers and booleans. An object field holds the related object's id, e.g. "12", a multiobject field a JSON list of ids in any order, e.g. jsonencode([12, 13]). A key removed from the map is cleared in NetBox (set {} to clear all).
    description String
    distance Number
    Link distance; requires distance_unit.
    distanceUnit String
    Unit of distance. One of: km, m, mi, ft.
    id Number
    NetBox id.
    interfaceAId Number
    Id of the first interface; it must be of a wireless type.
    interfaceBId Number
    Id of the second interface; it must be of a wireless type.
    lastUpdated String
    ownerId Number
    Id of the owner the object is assigned to.
    ssid String
    Service set identifier.
    status String
    Link status. One of: connected, planned, decommissioning.
    tags List<String>
    Slugs of the tags assigned to the object (the provider's defaulttags are added on top, see tagsall).
    tagsAlls List<String>
    Slugs of all tags on the object, including the provider's default_tags.
    tenantId Number
    Id of the tenant.
    url String
    customFieldFilters Map<String>
    Custom field values to match, by field name, e.g. { tier = "gold" }: each entry filters as cf_\n\n with the field's own filter logic, loose (case-insensitive substring) or exact.
    tagSlug String
    Slug of a tag the object carries.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox
    Viewing docs for netbox 6.0.0
    published on Wednesday, Nov 4, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial