1. Registry
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. getVlanTranslationPolicies
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger
netbox
Viewing docs for netbox 6.0.1
published on Monday, Nov 16, 2026 by e-breuninger

    Lists vlan_translation_policy objects matching the given filters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const test = netbox.getVlanTranslationPolicies({
        filters: [{
            name: "name",
            value: "test-vlan_translation_policy",
        }],
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    test = netbox.get_vlan_translation_policies(filters=[{
        "name": "name",
        "value": "test-vlan_translation_policy",
    }])
    
    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.GetVlanTranslationPolicies(ctx, &netbox.GetVlanTranslationPoliciesArgs{
    			Filters: []netbox.GetVlanTranslationPoliciesFilter{
    				{
    					Name:  "name",
    					Value: "test-vlan_translation_policy",
    				},
    			},
    		}, 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.GetVlanTranslationPolicies.Invoke(new()
        {
            Filters = new[]
            {
                new Netbox.Inputs.GetVlanTranslationPoliciesFilterInputArgs
                {
                    Name = "name",
                    Value = "test-vlan_translation_policy",
                },
            },
        });
    
    });
    
    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.GetVlanTranslationPoliciesArgs;
    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.getVlanTranslationPolicies(GetVlanTranslationPoliciesArgs.builder()
                .filters(GetVlanTranslationPoliciesFilterArgs.builder()
                    .name("name")
                    .value("test-vlan_translation_policy")
                    .build())
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netbox:getVlanTranslationPolicies
          arguments:
            filters:
              - name: name
                value: test-vlan_translation_policy
    
    Example coming soon!
    

    Using getVlanTranslationPolicies

    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 getVlanTranslationPolicies(args: GetVlanTranslationPoliciesArgs, opts?: InvokeOptions): Promise<GetVlanTranslationPoliciesResult>
    function getVlanTranslationPoliciesOutput(args: GetVlanTranslationPoliciesOutputArgs, opts?: InvokeOutputOptions): Output<GetVlanTranslationPoliciesResult>
    def get_vlan_translation_policies(filters: Optional[Sequence[GetVlanTranslationPoliciesFilter]] = None,
                                      limit: Optional[float] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetVlanTranslationPoliciesResult
    def get_vlan_translation_policies_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetVlanTranslationPoliciesFilterArgs]]]] = None,
                                      limit: pulumi.Input[Optional[float]] = None,
                                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetVlanTranslationPoliciesResult]
    func GetVlanTranslationPolicies(ctx *Context, args *GetVlanTranslationPoliciesArgs, opts ...InvokeOption) (*GetVlanTranslationPoliciesResult, error)
    func GetVlanTranslationPoliciesOutput(ctx *Context, args *GetVlanTranslationPoliciesOutputArgs, opts ...InvokeOption) GetVlanTranslationPoliciesResultOutput

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

    public static class GetVlanTranslationPolicies 
    {
        public static Task<GetVlanTranslationPoliciesResult> InvokeAsync(GetVlanTranslationPoliciesArgs args, InvokeOptions? opts = null)
        public static Output<GetVlanTranslationPoliciesResult> Invoke(GetVlanTranslationPoliciesInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetVlanTranslationPoliciesResult> Invoke(GetVlanTranslationPoliciesInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetVlanTranslationPoliciesResult> getVlanTranslationPolicies(GetVlanTranslationPoliciesArgs args, InvokeOptions options)
    public static Output<GetVlanTranslationPoliciesResult> getVlanTranslationPolicies(GetVlanTranslationPoliciesArgs args, InvokeOptions options)
    public static Output<GetVlanTranslationPoliciesResult> getVlanTranslationPolicies(GetVlanTranslationPoliciesArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: netbox:index/getVlanTranslationPolicies:getVlanTranslationPolicies
      arguments:
        # arguments dictionary
    data "netbox_get_vlan_translation_policies" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<GetVlanTranslationPoliciesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    Limit double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    Filters []GetVlanTranslationPoliciesFilter
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    Limit float64
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters List<GetVlanTranslationPoliciesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit Double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters GetVlanTranslationPoliciesFilter[]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters Sequence[GetVlanTranslationPoliciesFilter]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit float
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit Number
    The maximum number of objects to return from the API lookup. Defaults to 1000.

    getVlanTranslationPolicies Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    VlanTranslationPolicies List<GetVlanTranslationPoliciesVlanTranslationPolicy>
    The matching vlantranslationpolicies.
    Filters List<GetVlanTranslationPoliciesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    Limit double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    Id string
    The provider-assigned unique ID for this managed resource.
    VlanTranslationPolicies []GetVlanTranslationPoliciesVlanTranslationPolicy
    The matching vlantranslationpolicies.
    Filters []GetVlanTranslationPoliciesFilter
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    Limit float64
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id string
    The provider-assigned unique ID for this managed resource.
    vlan_translation_policies list(object)
    The matching vlantranslationpolicies.
    filters list(object)
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id String
    The provider-assigned unique ID for this managed resource.
    vlanTranslationPolicies List<GetVlanTranslationPoliciesVlanTranslationPolicy>
    The matching vlantranslationpolicies.
    filters List<GetVlanTranslationPoliciesFilter>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit Double
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id string
    The provider-assigned unique ID for this managed resource.
    vlanTranslationPolicies GetVlanTranslationPoliciesVlanTranslationPolicy[]
    The matching vlantranslationpolicies.
    filters GetVlanTranslationPoliciesFilter[]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit number
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id str
    The provider-assigned unique ID for this managed resource.
    vlan_translation_policies Sequence[GetVlanTranslationPoliciesVlanTranslationPolicy]
    The matching vlantranslationpolicies.
    filters Sequence[GetVlanTranslationPoliciesFilter]
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit float
    The maximum number of objects to return from the API lookup. Defaults to 1000.
    id String
    The provider-assigned unique ID for this managed resource.
    vlanTranslationPolicies List<Property Map>
    The matching vlantranslationpolicies.
    filters List<Property Map>
    Query filters, sent as API list parameters. Supported names: created, createdempty, createdgt, createdgte, createdlt, createdlte, createdn, description, descriptionempty, descriptionic, descriptionie, descriptioniew, descriptioniregex, descriptionisw, descriptionn, descriptionnic, descriptionnie, descriptionniew, descriptionnisw, descriptionregex, id, idempty, idgt, idgte, idlt, idlte, idn, lastupdated, lastupdatedempty, last_updatedgt, last_updatedgte, last_updatedlt, last_updatedlte, last_updatedn, name, nameempty, nameic, nameie, nameiew, nameiregex, nameisw, namen, namenic, namenie, nameniew, namenisw, nameregex, owner, ownern, ownergroup, ownergroupn, ownergroupid, ownergroupidn, ownerid, owneridn, q, tag, tagany, tagn, tagid, tagidany, tag_idn. Repeating a name sends that parameter once per value.
    limit Number
    The maximum number of objects to return from the API lookup. Defaults to 1000.

    Supporting Types

    GetVlanTranslationPoliciesFilter

    Name string
    Name of the query filter (the API list parameter).
    Value string
    Value to filter by.
    Name string
    Name of the query filter (the API list parameter).
    Value string
    Value to filter by.
    name string
    Name of the query filter (the API list parameter).
    value string
    Value to filter by.
    name String
    Name of the query filter (the API list parameter).
    value String
    Value to filter by.
    name string
    Name of the query filter (the API list parameter).
    value string
    Value to filter by.
    name str
    Name of the query filter (the API list parameter).
    value str
    Value to filter by.
    name String
    Name of the query filter (the API list parameter).
    value String
    Value to filter by.

    GetVlanTranslationPoliciesVlanTranslationPolicy

    Comments string
    Description string
    Id double
    NetBox id.
    Name string
    OwnerId double
    Id of the owner the object is assigned to.
    Url string
    Comments string
    Description string
    Id float64
    NetBox id.
    Name string
    OwnerId float64
    Id of the owner the object is assigned to.
    Url string
    comments string
    description string
    id number
    NetBox id.
    name string
    owner_id number
    Id of the owner the object is assigned to.
    url string
    comments String
    description String
    id Double
    NetBox id.
    name String
    ownerId Double
    Id of the owner the object is assigned to.
    url String
    comments string
    description string
    id number
    NetBox id.
    name string
    ownerId number
    Id of the owner the object is assigned to.
    url string
    comments str
    description str
    id float
    NetBox id.
    name str
    owner_id float
    Id of the owner the object is assigned to.
    url str
    comments String
    description String
    id Number
    NetBox id.
    name String
    ownerId Number
    Id of the owner the object is assigned to.
    url String

    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.1
    published on Monday, Nov 16, 2026 by e-breuninger

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial