1. Packages
  2. Netbox Provider
  3. API Docs
  4. getIpAddresses
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getIpAddresses

Explore with Pulumi AI

netbox logo
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

    Using getIpAddresses

    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 getIpAddresses(args: GetIpAddressesArgs, opts?: InvokeOptions): Promise<GetIpAddressesResult>
    function getIpAddressesOutput(args: GetIpAddressesOutputArgs, opts?: InvokeOptions): Output<GetIpAddressesResult>
    def get_ip_addresses(filters: Optional[Sequence[GetIpAddressesFilter]] = None,
                         id: Optional[str] = None,
                         limit: Optional[float] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIpAddressesResult
    def get_ip_addresses_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetIpAddressesFilterArgs]]]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         limit: Optional[pulumi.Input[float]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIpAddressesResult]
    func GetIpAddresses(ctx *Context, args *GetIpAddressesArgs, opts ...InvokeOption) (*GetIpAddressesResult, error)
    func GetIpAddressesOutput(ctx *Context, args *GetIpAddressesOutputArgs, opts ...InvokeOption) GetIpAddressesResultOutput

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

    public static class GetIpAddresses 
    {
        public static Task<GetIpAddressesResult> InvokeAsync(GetIpAddressesArgs args, InvokeOptions? opts = null)
        public static Output<GetIpAddressesResult> Invoke(GetIpAddressesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpAddressesResult> getIpAddresses(GetIpAddressesArgs args, InvokeOptions options)
    public static Output<GetIpAddressesResult> getIpAddresses(GetIpAddressesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getIpAddresses:getIpAddresses
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<GetIpAddressesFilter>
    Id string
    The ID of this resource.
    Limit double
    Defaults to 1000.
    Filters []GetIpAddressesFilter
    Id string
    The ID of this resource.
    Limit float64
    Defaults to 1000.
    filters List<GetIpAddressesFilter>
    id String
    The ID of this resource.
    limit Double
    Defaults to 1000.
    filters GetIpAddressesFilter[]
    id string
    The ID of this resource.
    limit number
    Defaults to 1000.
    filters Sequence[GetIpAddressesFilter]
    id str
    The ID of this resource.
    limit float
    Defaults to 1000.
    filters List<Property Map>
    id String
    The ID of this resource.
    limit Number
    Defaults to 1000.

    getIpAddresses Result

    The following output properties are available:

    Id string
    The ID of this resource.
    IpAddresses List<GetIpAddressesIpAddress>
    Filters List<GetIpAddressesFilter>
    Limit double
    Defaults to 1000.
    Id string
    The ID of this resource.
    IpAddresses []GetIpAddressesIpAddress
    Filters []GetIpAddressesFilter
    Limit float64
    Defaults to 1000.
    id String
    The ID of this resource.
    ipAddresses List<GetIpAddressesIpAddress>
    filters List<GetIpAddressesFilter>
    limit Double
    Defaults to 1000.
    id string
    The ID of this resource.
    ipAddresses GetIpAddressesIpAddress[]
    filters GetIpAddressesFilter[]
    limit number
    Defaults to 1000.
    id String
    The ID of this resource.
    ipAddresses List<Property Map>
    filters List<Property Map>
    limit Number
    Defaults to 1000.

    Supporting Types

    GetIpAddressesFilter

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GetIpAddressesIpAddress

    GetIpAddressesIpAddressTag

    Display string
    Id double
    Name string
    Slug string
    Display string
    Id float64
    Name string
    Slug string
    display String
    id Double
    name String
    slug String
    display string
    id number
    name string
    slug string
    display str
    id float
    name str
    slug str
    display String
    id Number
    name String
    slug String

    GetIpAddressesIpAddressTenant

    Id double
    Name string
    Slug string
    Id float64
    Name string
    Slug string
    id Double
    name String
    slug String
    id number
    name string
    slug string
    id float
    name str
    slug str
    id Number
    name String
    slug String

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger