Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getAddressGroupsV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getAddressGroupsV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    List all the Address Groups.

    Example Usage

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

const addrGroup = nutanix.getAddressGroupsV2({});
const addrGroupFiltered = nutanix.getAddressGroupsV2({
    filter: "name eq '%[1]s'",
});

    import pulumi
import pulumi_nutanix as nutanix

addr_group = nutanix.get_address_groups_v2()
addr_group_filtered = nutanix.get_address_groups_v2(filter="name eq '%[1]s'")

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.LookupAddressGroupsV2(ctx, &nutanix.LookupAddressGroupsV2Args{}, nil)
		if err != nil {
			return err
		}
		_, err = nutanix.LookupAddressGroupsV2(ctx, &nutanix.LookupAddressGroupsV2Args{
			Filter: pulumi.StringRef("name eq '%[1]s'"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var addrGroup = Nutanix.GetAddressGroupsV2.Invoke();

    var addrGroupFiltered = Nutanix.GetAddressGroupsV2.Invoke(new()
    {
        Filter = "name eq '%[1]s'",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetAddressGroupsV2Args;
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 addrGroup = NutanixFunctions.getAddressGroupsV2();

        final var addrGroupFiltered = NutanixFunctions.getAddressGroupsV2(GetAddressGroupsV2Args.builder()
            .filter("name eq '%[1]s'")
            .build());

    }
}

    variables:
  addrGroup:
    fn::invoke:
      function: nutanix:getAddressGroupsV2
      arguments: {}
  addrGroupFiltered:
    fn::invoke:
      function: nutanix:getAddressGroupsV2
      arguments:
        filter: name eq '%[1]s'

    Using getAddressGroupsV2

    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 getAddressGroupsV2(args: GetAddressGroupsV2Args, opts?: InvokeOptions): Promise<GetAddressGroupsV2Result>
function getAddressGroupsV2Output(args: GetAddressGroupsV2OutputArgs, opts?: InvokeOptions): Output<GetAddressGroupsV2Result>
    def get_address_groups_v2(filter: Optional[str] = None,
                          limit: Optional[int] = None,
                          order_by: Optional[str] = None,
                          page: Optional[int] = None,
                          select: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAddressGroupsV2Result
def get_address_groups_v2_output(filter: Optional[pulumi.Input[str]] = None,
                          limit: Optional[pulumi.Input[int]] = None,
                          order_by: Optional[pulumi.Input[str]] = None,
                          page: Optional[pulumi.Input[int]] = None,
                          select: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAddressGroupsV2Result]
    func LookupAddressGroupsV2(ctx *Context, args *LookupAddressGroupsV2Args, opts ...InvokeOption) (*LookupAddressGroupsV2Result, error)
func LookupAddressGroupsV2Output(ctx *Context, args *LookupAddressGroupsV2OutputArgs, opts ...InvokeOption) LookupAddressGroupsV2ResultOutput

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

    public static class GetAddressGroupsV2 
{
    public static Task<GetAddressGroupsV2Result> InvokeAsync(GetAddressGroupsV2Args args, InvokeOptions? opts = null)
    public static Output<GetAddressGroupsV2Result> Invoke(GetAddressGroupsV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAddressGroupsV2Result> getAddressGroupsV2(GetAddressGroupsV2Args args, InvokeOptions options)
public static Output<GetAddressGroupsV2Result> getAddressGroupsV2(GetAddressGroupsV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getAddressGroupsV2:getAddressGroupsV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filter string
    A URL query parameter that allows clients to filter a collection of resources.
    Limit int
    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    OrderBy string
    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default
    Page int
    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
    Select string
    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions
    Filter string
    A URL query parameter that allows clients to filter a collection of resources.
    Limit int
    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    OrderBy string
    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default
    Page int
    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
    Select string
    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions
    filter String
    A URL query parameter that allows clients to filter a collection of resources.
    limit Integer
    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    orderBy String
    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default
    page Integer
    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
    select String
    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions
    filter string
    A URL query parameter that allows clients to filter a collection of resources.
    limit number
    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    orderBy string
    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default
    page number
    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
    select string
    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions
    filter str
    A URL query parameter that allows clients to filter a collection of resources.
    limit int
    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    order_by str
    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default
    page int
    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
    select str
    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions
    filter String
    A URL query parameter that allows clients to filter a collection of resources.
    limit Number
    A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    orderBy String
    A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default
    page Number
    A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
    select String
    A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions

    getAddressGroupsV2 Result

    The following output properties are available:

    AddressGroups List<PiersKarsenbarg.Nutanix.Outputs.GetAddressGroupsV2AddressGroup>
    Id string
    The provider-assigned unique ID for this managed resource.
    Filter string
    Limit int
    OrderBy string
    Page int
    Select string
    AddressGroups []GetAddressGroupsV2AddressGroup
    Id string
    The provider-assigned unique ID for this managed resource.
    Filter string
    Limit int
    OrderBy string
    Page int
    Select string
    addressGroups List<GetAddressGroupsV2AddressGroup>
    id String
    The provider-assigned unique ID for this managed resource.
    filter String
    limit Integer
    orderBy String
    page Integer
    select String
    addressGroups GetAddressGroupsV2AddressGroup[]
    id string
    The provider-assigned unique ID for this managed resource.
    filter string
    limit number
    orderBy string
    page number
    select string
    address_groups Sequence[GetAddressGroupsV2AddressGroup]
    id str
    The provider-assigned unique ID for this managed resource.
    filter str
    limit int
    order_by str
    page int
    select str
    addressGroups List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    filter String
    limit Number
    orderBy String
    page Number
    select String

    Supporting Types

    GetAddressGroupsV2AddressGroup

    CreatedBy string
    created by.
    Description string
    A user defined annotation for an Address Group.
    ExtId string
    Address group UUID.
    IpRanges List<PiersKarsenbarg.Nutanix.Inputs.GetAddressGroupsV2AddressGroupIpRange>
    List of IP range containing start and end IP
    Ipv4Addresses List<PiersKarsenbarg.Nutanix.Inputs.GetAddressGroupsV2AddressGroupIpv4Address>
    List of CIDR blocks in the Address Group.
    Links List<PiersKarsenbarg.Nutanix.Inputs.GetAddressGroupsV2AddressGroupLink>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Name string
    A short identifier for an Address Group.
    PolicyReferences List<string>
    Reference to policy associated with Address Group.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    CreatedBy string
    created by.
    Description string
    A user defined annotation for an Address Group.
    ExtId string
    Address group UUID.
    IpRanges []GetAddressGroupsV2AddressGroupIpRange
    List of IP range containing start and end IP
    Ipv4Addresses []GetAddressGroupsV2AddressGroupIpv4Address
    List of CIDR blocks in the Address Group.
    Links []GetAddressGroupsV2AddressGroupLink
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Name string
    A short identifier for an Address Group.
    PolicyReferences []string
    Reference to policy associated with Address Group.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    createdBy String
    created by.
    description String
    A user defined annotation for an Address Group.
    extId String
    Address group UUID.
    ipRanges List<GetAddressGroupsV2AddressGroupIpRange>
    List of IP range containing start and end IP
    ipv4Addresses List<GetAddressGroupsV2AddressGroupIpv4Address>
    List of CIDR blocks in the Address Group.
    links List<GetAddressGroupsV2AddressGroupLink>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name String
    A short identifier for an Address Group.
    policyReferences List<String>
    Reference to policy associated with Address Group.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    createdBy string
    created by.
    description string
    A user defined annotation for an Address Group.
    extId string
    Address group UUID.
    ipRanges GetAddressGroupsV2AddressGroupIpRange[]
    List of IP range containing start and end IP
    ipv4Addresses GetAddressGroupsV2AddressGroupIpv4Address[]
    List of CIDR blocks in the Address Group.
    links GetAddressGroupsV2AddressGroupLink[]
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name string
    A short identifier for an Address Group.
    policyReferences string[]
    Reference to policy associated with Address Group.
    tenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    created_by str
    created by.
    description str
    A user defined annotation for an Address Group.
    ext_id str
    Address group UUID.
    ip_ranges Sequence[GetAddressGroupsV2AddressGroupIpRange]
    List of IP range containing start and end IP
    ipv4_addresses Sequence[GetAddressGroupsV2AddressGroupIpv4Address]
    List of CIDR blocks in the Address Group.
    links Sequence[GetAddressGroupsV2AddressGroupLink]
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name str
    A short identifier for an Address Group.
    policy_references Sequence[str]
    Reference to policy associated with Address Group.
    tenant_id str
    A globally unique identifier that represents the tenant that owns this entity.
    createdBy String
    created by.
    description String
    A user defined annotation for an Address Group.
    extId String
    Address group UUID.
    ipRanges List<Property Map>
    List of IP range containing start and end IP
    ipv4Addresses List<Property Map>
    List of CIDR blocks in the Address Group.
    links List<Property Map>
    A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name String
    A short identifier for an Address Group.
    policyReferences List<String>
    Reference to policy associated with Address Group.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.

    GetAddressGroupsV2AddressGroupIpRange

    EndIp string
    end ip
    StartIp string
    start ip
    EndIp string
    end ip
    StartIp string
    start ip
    endIp String
    end ip
    startIp String
    start ip
    endIp string
    end ip
    startIp string
    start ip
    end_ip str
    end ip
    start_ip str
    start ip
    endIp String
    end ip
    startIp String
    start ip

    GetAddressGroupsV2AddressGroupIpv4Address

    PrefixLength int
    The prefix length of the network to which this host IPv4 address belongs.
    Value string
    ip of address
    PrefixLength int
    The prefix length of the network to which this host IPv4 address belongs.
    Value string
    ip of address
    prefixLength Integer
    The prefix length of the network to which this host IPv4 address belongs.
    value String
    ip of address
    prefixLength number
    The prefix length of the network to which this host IPv4 address belongs.
    value string
    ip of address
    prefix_length int
    The prefix length of the network to which this host IPv4 address belongs.
    value str
    ip of address
    prefixLength Number
    The prefix length of the network to which this host IPv4 address belongs.
    value String
    ip of address
    Href string
    Rel string
    Href string
    Rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix