avi 31.1.1, Apr 14 25

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

avi.Ipaddrgroup

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-resource-ipaddrgroup” description: |- Creates and manages Avi IpAddrGroup.

avi.Ipaddrgroup

The IpAddrGroup resource allows the creation and management of Avi IpAddrGroup

Example Usage

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

const foo = new avi.Ipaddrgroup("foo", {tenantRef: "/api/tenant/?name=admin"});

import pulumi
import pulumi_avi as avi

foo = avi.Ipaddrgroup("foo", tenant_ref="/api/tenant/?name=admin")

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.NewIpaddrgroup(ctx, "foo", &avi.IpaddrgroupArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		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 foo = new Avi.Ipaddrgroup("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Ipaddrgroup;
import com.pulumi.avi.IpaddrgroupArgs;
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) {
        var foo = new Ipaddrgroup("foo", IpaddrgroupArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

resources:
  foo:
    type: avi:Ipaddrgroup
    properties:
      tenantRef: /api/tenant/?name=admin

Create Ipaddrgroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Ipaddrgroup(name: string, args?: IpaddrgroupArgs, opts?: CustomResourceOptions);

@overload
def Ipaddrgroup(resource_name: str,
                args: Optional[IpaddrgroupArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def Ipaddrgroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                addrs: Optional[Sequence[IpaddrgroupAddrArgs]] = None,
                configpb_attributes: Optional[Sequence[IpaddrgroupConfigpbAttributeArgs]] = None,
                country_codes: Optional[Sequence[str]] = None,
                description: Optional[str] = None,
                ip_ports: Optional[Sequence[IpaddrgroupIpPortArgs]] = None,
                ipaddrgroup_id: Optional[str] = None,
                marathon_app_name: Optional[str] = None,
                marathon_service_port: Optional[str] = None,
                markers: Optional[Sequence[IpaddrgroupMarkerArgs]] = None,
                name: Optional[str] = None,
                prefixes: Optional[Sequence[IpaddrgroupPrefixArgs]] = None,
                ranges: Optional[Sequence[IpaddrgroupRangeArgs]] = None,
                tenant_ref: Optional[str] = None,
                uuid: Optional[str] = None)

func NewIpaddrgroup(ctx *Context, name string, args *IpaddrgroupArgs, opts ...ResourceOption) (*Ipaddrgroup, error)

public Ipaddrgroup(string name, IpaddrgroupArgs? args = null, CustomResourceOptions? opts = null)

public Ipaddrgroup(String name, IpaddrgroupArgs args)
public Ipaddrgroup(String name, IpaddrgroupArgs args, CustomResourceOptions options)

type: avi:Ipaddrgroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args IpaddrgroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args IpaddrgroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IpaddrgroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IpaddrgroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IpaddrgroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ipaddrgroupResource = new Avi.Ipaddrgroup("ipaddrgroupResource", new()
{
    Addrs = new[]
    {
        new Avi.Inputs.IpaddrgroupAddrArgs
        {
            Addr = "string",
            Type = "string",
        },
    },
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.IpaddrgroupConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    CountryCodes = new[]
    {
        "string",
    },
    Description = "string",
    IpPorts = new[]
    {
        new Avi.Inputs.IpaddrgroupIpPortArgs
        {
            Port = "string",
            Hostname = "string",
            Ips = new[]
            {
                new Avi.Inputs.IpaddrgroupIpPortIpArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            Name = "string",
        },
    },
    IpaddrgroupId = "string",
    MarathonAppName = "string",
    MarathonServicePort = "string",
    Markers = new[]
    {
        new Avi.Inputs.IpaddrgroupMarkerArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    Prefixes = new[]
    {
        new Avi.Inputs.IpaddrgroupPrefixArgs
        {
            IpAddrs = new[]
            {
                new Avi.Inputs.IpaddrgroupPrefixIpAddrArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            Mask = "string",
        },
    },
    Ranges = new[]
    {
        new Avi.Inputs.IpaddrgroupRangeArgs
        {
            Begins = new[]
            {
                new Avi.Inputs.IpaddrgroupRangeBeginArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            Ends = new[]
            {
                new Avi.Inputs.IpaddrgroupRangeEndArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
        },
    },
    TenantRef = "string",
    Uuid = "string",
});

example, err := avi.NewIpaddrgroup(ctx, "ipaddrgroupResource", &avi.IpaddrgroupArgs{
	Addrs: avi.IpaddrgroupAddrArray{
		&avi.IpaddrgroupAddrArgs{
			Addr: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	ConfigpbAttributes: avi.IpaddrgroupConfigpbAttributeArray{
		&avi.IpaddrgroupConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	CountryCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	IpPorts: avi.IpaddrgroupIpPortArray{
		&avi.IpaddrgroupIpPortArgs{
			Port:     pulumi.String("string"),
			Hostname: pulumi.String("string"),
			Ips: avi.IpaddrgroupIpPortIpArray{
				&avi.IpaddrgroupIpPortIpArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			Name: pulumi.String("string"),
		},
	},
	IpaddrgroupId:       pulumi.String("string"),
	MarathonAppName:     pulumi.String("string"),
	MarathonServicePort: pulumi.String("string"),
	Markers: avi.IpaddrgroupMarkerArray{
		&avi.IpaddrgroupMarkerArgs{
			Key: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name: pulumi.String("string"),
	Prefixes: avi.IpaddrgroupPrefixArray{
		&avi.IpaddrgroupPrefixArgs{
			IpAddrs: avi.IpaddrgroupPrefixIpAddrArray{
				&avi.IpaddrgroupPrefixIpAddrArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			Mask: pulumi.String("string"),
		},
	},
	Ranges: avi.IpaddrgroupRangeArray{
		&avi.IpaddrgroupRangeArgs{
			Begins: avi.IpaddrgroupRangeBeginArray{
				&avi.IpaddrgroupRangeBeginArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			Ends: avi.IpaddrgroupRangeEndArray{
				&avi.IpaddrgroupRangeEndArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
		},
	},
	TenantRef: pulumi.String("string"),
	Uuid:      pulumi.String("string"),
})

var ipaddrgroupResource = new Ipaddrgroup("ipaddrgroupResource", IpaddrgroupArgs.builder()
    .addrs(IpaddrgroupAddrArgs.builder()
        .addr("string")
        .type("string")
        .build())
    .configpbAttributes(IpaddrgroupConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .countryCodes("string")
    .description("string")
    .ipPorts(IpaddrgroupIpPortArgs.builder()
        .port("string")
        .hostname("string")
        .ips(IpaddrgroupIpPortIpArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .name("string")
        .build())
    .ipaddrgroupId("string")
    .marathonAppName("string")
    .marathonServicePort("string")
    .markers(IpaddrgroupMarkerArgs.builder()
        .key("string")
        .values("string")
        .build())
    .name("string")
    .prefixes(IpaddrgroupPrefixArgs.builder()
        .ipAddrs(IpaddrgroupPrefixIpAddrArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .mask("string")
        .build())
    .ranges(IpaddrgroupRangeArgs.builder()
        .begins(IpaddrgroupRangeBeginArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .ends(IpaddrgroupRangeEndArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .build())
    .tenantRef("string")
    .uuid("string")
    .build());

ipaddrgroup_resource = avi.Ipaddrgroup("ipaddrgroupResource",
    addrs=[{
        "addr": "string",
        "type": "string",
    }],
    configpb_attributes=[{
        "version": "string",
    }],
    country_codes=["string"],
    description="string",
    ip_ports=[{
        "port": "string",
        "hostname": "string",
        "ips": [{
            "addr": "string",
            "type": "string",
        }],
        "name": "string",
    }],
    ipaddrgroup_id="string",
    marathon_app_name="string",
    marathon_service_port="string",
    markers=[{
        "key": "string",
        "values": ["string"],
    }],
    name="string",
    prefixes=[{
        "ip_addrs": [{
            "addr": "string",
            "type": "string",
        }],
        "mask": "string",
    }],
    ranges=[{
        "begins": [{
            "addr": "string",
            "type": "string",
        }],
        "ends": [{
            "addr": "string",
            "type": "string",
        }],
    }],
    tenant_ref="string",
    uuid="string")

const ipaddrgroupResource = new avi.Ipaddrgroup("ipaddrgroupResource", {
    addrs: [{
        addr: "string",
        type: "string",
    }],
    configpbAttributes: [{
        version: "string",
    }],
    countryCodes: ["string"],
    description: "string",
    ipPorts: [{
        port: "string",
        hostname: "string",
        ips: [{
            addr: "string",
            type: "string",
        }],
        name: "string",
    }],
    ipaddrgroupId: "string",
    marathonAppName: "string",
    marathonServicePort: "string",
    markers: [{
        key: "string",
        values: ["string"],
    }],
    name: "string",
    prefixes: [{
        ipAddrs: [{
            addr: "string",
            type: "string",
        }],
        mask: "string",
    }],
    ranges: [{
        begins: [{
            addr: "string",
            type: "string",
        }],
        ends: [{
            addr: "string",
            type: "string",
        }],
    }],
    tenantRef: "string",
    uuid: "string",
});

type: avi:Ipaddrgroup
properties:
    addrs:
        - addr: string
          type: string
    configpbAttributes:
        - version: string
    countryCodes:
        - string
    description: string
    ipPorts:
        - hostname: string
          ips:
            - addr: string
              type: string
          name: string
          port: string
    ipaddrgroupId: string
    marathonAppName: string
    marathonServicePort: string
    markers:
        - key: string
          values:
            - string
    name: string
    prefixes:
        - ipAddrs:
            - addr: string
              type: string
          mask: string
    ranges:
        - begins:
            - addr: string
              type: string
          ends:
            - addr: string
              type: string
    tenantRef: string
    uuid: string

Ipaddrgroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Ipaddrgroup resource accepts the following input properties:

Addrs List<IpaddrgroupAddr>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<IpaddrgroupConfigpbAttribute>: 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.
IpPorts List<IpaddrgroupIpPort>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IpaddrgroupId string
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<IpaddrgroupMarker>: 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<IpaddrgroupPrefix>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ranges List<IpaddrgroupRange>: 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 []IpaddrgroupAddrArgs: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []IpaddrgroupConfigpbAttributeArgs: 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.
IpPorts []IpaddrgroupIpPortArgs: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IpaddrgroupId string
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 []IpaddrgroupMarkerArgs: 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 []IpaddrgroupPrefixArgs: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ranges []IpaddrgroupRangeArgs: 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<IpaddrgroupAddr>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<IpaddrgroupConfigpbAttribute>: 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.
ipPorts List<IpaddrgroupIpPort>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroupId String
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<IpaddrgroupMarker>: 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<IpaddrgroupPrefix>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges List<IpaddrgroupRange>: 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 IpaddrgroupAddr[]: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes IpaddrgroupConfigpbAttribute[]: 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.
ipPorts IpaddrgroupIpPort[]: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroupId string
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 IpaddrgroupMarker[]: 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 IpaddrgroupPrefix[]: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges IpaddrgroupRange[]: 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[IpaddrgroupAddrArgs]: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[IpaddrgroupConfigpbAttributeArgs]: 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.
ip_ports Sequence[IpaddrgroupIpPortArgs]: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroup_id str
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[IpaddrgroupMarkerArgs]: 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[IpaddrgroupPrefixArgs]: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges Sequence[IpaddrgroupRangeArgs]: 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.
ipPorts List<Property Map>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroupId String
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Ipaddrgroup resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Ipaddrgroup Resource

Get an existing Ipaddrgroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IpaddrgroupState, opts?: CustomResourceOptions): Ipaddrgroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addrs: Optional[Sequence[IpaddrgroupAddrArgs]] = None,
        configpb_attributes: Optional[Sequence[IpaddrgroupConfigpbAttributeArgs]] = None,
        country_codes: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        ip_ports: Optional[Sequence[IpaddrgroupIpPortArgs]] = None,
        ipaddrgroup_id: Optional[str] = None,
        marathon_app_name: Optional[str] = None,
        marathon_service_port: Optional[str] = None,
        markers: Optional[Sequence[IpaddrgroupMarkerArgs]] = None,
        name: Optional[str] = None,
        prefixes: Optional[Sequence[IpaddrgroupPrefixArgs]] = None,
        ranges: Optional[Sequence[IpaddrgroupRangeArgs]] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None) -> Ipaddrgroup

func GetIpaddrgroup(ctx *Context, name string, id IDInput, state *IpaddrgroupState, opts ...ResourceOption) (*Ipaddrgroup, error)

public static Ipaddrgroup Get(string name, Input<string> id, IpaddrgroupState? state, CustomResourceOptions? opts = null)

public static Ipaddrgroup get(String name, Output<String> id, IpaddrgroupState state, CustomResourceOptions options)

resources:  _:    type: avi:Ipaddrgroup    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Addrs List<IpaddrgroupAddr>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes List<IpaddrgroupConfigpbAttribute>: 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.
IpPorts List<IpaddrgroupIpPort>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IpaddrgroupId string
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<IpaddrgroupMarker>: 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<IpaddrgroupPrefix>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ranges List<IpaddrgroupRange>: 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 []IpaddrgroupAddrArgs: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ConfigpbAttributes []IpaddrgroupConfigpbAttributeArgs: 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.
IpPorts []IpaddrgroupIpPortArgs: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
IpaddrgroupId string
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 []IpaddrgroupMarkerArgs: 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 []IpaddrgroupPrefixArgs: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Ranges []IpaddrgroupRangeArgs: 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<IpaddrgroupAddr>: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes List<IpaddrgroupConfigpbAttribute>: 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.
ipPorts List<IpaddrgroupIpPort>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroupId String
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<IpaddrgroupMarker>: 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<IpaddrgroupPrefix>: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges List<IpaddrgroupRange>: 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 IpaddrgroupAddr[]: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpbAttributes IpaddrgroupConfigpbAttribute[]: 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.
ipPorts IpaddrgroupIpPort[]: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroupId string
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 IpaddrgroupMarker[]: 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 IpaddrgroupPrefix[]: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges IpaddrgroupRange[]: 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[IpaddrgroupAddrArgs]: Configure ip address(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
configpb_attributes Sequence[IpaddrgroupConfigpbAttributeArgs]: 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.
ip_ports Sequence[IpaddrgroupIpPortArgs]: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroup_id str
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[IpaddrgroupMarkerArgs]: 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[IpaddrgroupPrefixArgs]: Configure ip address prefix(es). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ranges Sequence[IpaddrgroupRangeArgs]: 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.
ipPorts List<Property Map>: Configure (ip address, port) tuple(s). Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ipaddrgroupId String
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.

Supporting Types

IpaddrgroupAddr, IpaddrgroupAddrArgs

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

IpaddrgroupConfigpbAttribute, IpaddrgroupConfigpbAttributeArgs

Version string

Version string

version String

version string

version str

version String

IpaddrgroupIpPort, IpaddrgroupIpPortArgs

Port string
Hostname string
Ips List<IpaddrgroupIpPortIp>
Name string: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Port string
Hostname string
Ips []IpaddrgroupIpPortIp
Name string: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

port String
hostname String
ips List<IpaddrgroupIpPortIp>
name String: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

port string
hostname string
ips IpaddrgroupIpPortIp[]
name string: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

port str
hostname str
ips Sequence[IpaddrgroupIpPortIp]
name str: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

port String
hostname String
ips List<Property Map>
name String: Name of the ip address group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

IpaddrgroupIpPortIp, IpaddrgroupIpPortIpArgs

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

IpaddrgroupMarker, IpaddrgroupMarkerArgs

Key string
Values List<string>

Key string
Values []string

key String
values List<String>

key string
values string[]

key str
values Sequence[str]

key String
values List<String>

IpaddrgroupPrefix, IpaddrgroupPrefixArgs

IpAddrs List<IpaddrgroupPrefixIpAddr>
Mask string

IpAddrs []IpaddrgroupPrefixIpAddr
Mask string

ipAddrs List<IpaddrgroupPrefixIpAddr>
mask String

ipAddrs IpaddrgroupPrefixIpAddr[]
mask string

ip_addrs Sequence[IpaddrgroupPrefixIpAddr]
mask str

ipAddrs List<Property Map>
mask String

IpaddrgroupPrefixIpAddr, IpaddrgroupPrefixIpAddrArgs

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

Begins []IpaddrgroupRangeBegin
Ends []IpaddrgroupRangeEnd

begins List<IpaddrgroupRangeBegin>
ends List<IpaddrgroupRangeEnd>

begins IpaddrgroupRangeBegin[]
ends IpaddrgroupRangeEnd[]

begins Sequence[IpaddrgroupRangeBegin]
ends Sequence[IpaddrgroupRangeEnd]

begins List<Property Map>
ends List<Property Map>

IpaddrgroupRangeBegin, IpaddrgroupRangeBeginArgs

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

IpaddrgroupRangeEnd, IpaddrgroupRangeEndArgs

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

Package Details

Repository: avi vmware/terraform-provider-avi
License
Notes: This Pulumi package is based on the avi Terraform Provider.

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

vmware/terraform-provider-avi

avi.Ipaddrgroup

On this page

On this page

<!–

–>

layout: “avi”

page_title: “Avi: avi.Ipaddrgroup” sidebar_current: “docs-avi-resource-ipaddrgroup” description: |- Creates and manages Avi IpAddrGroup.

avi.Ipaddrgroup

Example Usage

Create Ipaddrgroup Resource

Constructor syntax

Parameters

Constructor example

Ipaddrgroup Resource Properties

Inputs

Outputs

Look up Existing Ipaddrgroup Resource

Supporting Types

IpaddrgroupAddr, IpaddrgroupAddrArgs

IpaddrgroupConfigpbAttribute, IpaddrgroupConfigpbAttributeArgs

IpaddrgroupIpPort, IpaddrgroupIpPortArgs

IpaddrgroupIpPortIp, IpaddrgroupIpPortIpArgs

IpaddrgroupMarker, IpaddrgroupMarkerArgs

IpaddrgroupPrefix, IpaddrgroupPrefixArgs

IpaddrgroupPrefixIpAddr, IpaddrgroupPrefixIpAddrArgs

IpaddrgroupRange, IpaddrgroupRangeArgs

IpaddrgroupRangeBegin, IpaddrgroupRangeBeginArgs

IpaddrgroupRangeEnd, IpaddrgroupRangeEndArgs

Package Details

On this page

On this page