avi.getIpaddrgroup

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “AVI: avi.Ipaddrgroup” sidebar_current: “docs-avi-datasource-ipaddrgroup” description: |- Get information of Avi IpAddrGroup.

avi.Ipaddrgroup

This data source is used to to get avi.Ipaddrgroup objects.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const fooIpaddrgroup = avi.getIpaddrgroup({
    name: "foo",
    uuid: "ipaddrgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_ipaddrgroup = avi.get_ipaddrgroup(name="foo",
    uuid="ipaddrgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupIpaddrgroup(ctx, &avi.LookupIpaddrgroupArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("ipaddrgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooIpaddrgroup = Avi.GetIpaddrgroup.Invoke(new()
    {
        Name = "foo",
        Uuid = "ipaddrgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetIpaddrgroupArgs;
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 fooIpaddrgroup = AviFunctions.getIpaddrgroup(GetIpaddrgroupArgs.builder()
            .name("foo")
            .uuid("ipaddrgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooIpaddrgroup:
    fn::invoke:
      function: avi:getIpaddrgroup
      arguments:
        name: foo
        uuid: ipaddrgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getIpaddrgroup

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 getIpaddrgroup(args: GetIpaddrgroupArgs, opts?: InvokeOptions): Promise<GetIpaddrgroupResult>
function getIpaddrgroupOutput(args: GetIpaddrgroupOutputArgs, opts?: InvokeOptions): Output<GetIpaddrgroupResult>

def get_ipaddrgroup(id: Optional[str] = None,
                    name: Optional[str] = None,
                    tenant_ref: Optional[str] = None,
                    uuid: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetIpaddrgroupResult
def get_ipaddrgroup_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    tenant_ref: Optional[pulumi.Input[str]] = None,
                    uuid: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetIpaddrgroupResult]

func LookupIpaddrgroup(ctx *Context, args *LookupIpaddrgroupArgs, opts ...InvokeOption) (*LookupIpaddrgroupResult, error)
func LookupIpaddrgroupOutput(ctx *Context, args *LookupIpaddrgroupOutputArgs, opts ...InvokeOption) LookupIpaddrgroupResultOutput

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

public static class GetIpaddrgroup 
{
    public static Task<GetIpaddrgroupResult> InvokeAsync(GetIpaddrgroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIpaddrgroupResult> Invoke(GetIpaddrgroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpaddrgroupResult> getIpaddrgroup(GetIpaddrgroupArgs args, InvokeOptions options)
public static Output<GetIpaddrgroupResult> getIpaddrgroup(GetIpaddrgroupArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getIpaddrgroup:getIpaddrgroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string: Search IpAddrGroup by name.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Search IpAddrGroup by uuid.

Id string
Name string: Search IpAddrGroup by name.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Search IpAddrGroup by uuid.

id String
name String: Search IpAddrGroup by name.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Search IpAddrGroup by uuid.

id string
name string: Search IpAddrGroup by name.
tenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Search IpAddrGroup by uuid.

id str
name str: Search IpAddrGroup by name.
tenant_ref str: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Search IpAddrGroup by uuid.

id String
name String: Search IpAddrGroup by name.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Search IpAddrGroup by uuid.

getIpaddrgroup Result

The following output properties are available:

Addrs List<GetIpaddrgroupAddr>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<GetIpaddrgroupConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CountryCodes List<string>: Populate the ip address ranges from the geo database for this country. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
IpPorts List<GetIpaddrgroupIpPort>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
MarathonAppName string: Populate ip addresses from tasks of this marathon app. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
MarathonServicePort string: Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers List<GetIpaddrgroupMarker>: List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Prefixes List<GetIpaddrgroupPrefix>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ranges List<GetIpaddrgroupRange>: Configure ip address range(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Uuid of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Addrs []GetIpaddrgroupAddr: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []GetIpaddrgroupConfigpbAttribute: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
CountryCodes []string: Populate the ip address ranges from the geo database for this country. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
IpPorts []GetIpaddrgroupIpPort: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
MarathonAppName string: Populate ip addresses from tasks of this marathon app. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
MarathonServicePort string: Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers []GetIpaddrgroupMarker: List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Prefixes []GetIpaddrgroupPrefix: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ranges []GetIpaddrgroupRange: Configure ip address range(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string: Uuid of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

addrs List<GetIpaddrgroupAddr>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<GetIpaddrgroupConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
countryCodes List<String>: Populate the ip address ranges from the geo database for this country. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
ipPorts List<GetIpaddrgroupIpPort>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathonAppName String: Populate ip addresses from tasks of this marathon app. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathonServicePort String: Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<GetIpaddrgroupMarker>: List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
prefixes List<GetIpaddrgroupPrefix>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges List<GetIpaddrgroupRange>: Configure ip address range(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Uuid of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

addrs GetIpaddrgroupAddr[]: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes GetIpaddrgroupConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
countryCodes string[]: Populate the ip address ranges from the geo database for this country. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
ipPorts GetIpaddrgroupIpPort[]: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathonAppName string: Populate ip addresses from tasks of this marathon app. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathonServicePort string: Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers GetIpaddrgroupMarker[]: List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
prefixes GetIpaddrgroupPrefix[]: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges GetIpaddrgroupRange[]: Configure ip address range(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string: Uuid of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

addrs Sequence[GetIpaddrgroupAddr]: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[GetIpaddrgroupConfigpbAttribute]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
country_codes Sequence[str]: Populate the ip address ranges from the geo database for this country. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
ip_ports Sequence[GetIpaddrgroupIpPort]: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathon_app_name str: Populate ip addresses from tasks of this marathon app. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathon_service_port str: Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers Sequence[GetIpaddrgroupMarker]: List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
prefixes Sequence[GetIpaddrgroupPrefix]: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges Sequence[GetIpaddrgroupRange]: Configure ip address range(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str: Uuid of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

addrs List<Property Map>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<Property Map>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
countryCodes List<String>: Populate the ip address ranges from the geo database for this country. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String: Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
ipPorts List<Property Map>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathonAppName String: Populate ip addresses from tasks of this marathon app. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
marathonServicePort String: Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<Property Map>: List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
prefixes List<Property Map>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges List<Property Map>: Configure ip address range(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String: It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String: Uuid of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.