Nutanix v0.8.0, May 11 25

Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

nutanix.getSubnetsV2

Explore with Pulumi AI

Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

pierskarsenbarg/pulumi-nutanix

Subnets

The subnets object contains the following attributes:

ext_id: A globally unique identifier of an instance that is suitable for external consumption.
name: Name of the subnet.
description: Description of the subnet.
subnet_type: Type of subnet.
network_id: or VLAN subnet, this field represents VLAN Id, valid range is from 0 to 4095; For overlay subnet, this field represents 24-bit VNI, this field is read-only.
dhcp_options: List of DHCP options to be configured.
ip_config: IP configuration for the subnet.
cluster_reference: UUID of the cluster this subnet belongs to.
virtual_switch_reference: UUID of the virtual switch this subnet belongs to (type VLAN only).
vpc_reference: UUID of Virtual Private Cloud this subnet belongs to (type Overlay only).
is_nat_enabled: Indicates whether NAT must be enabled for VPCs attached to the subnet. This is supported only for external subnets. NAT is enabled by default on external subnets.
is_external: Indicates whether the subnet is used for external connectivity.
reserved_ip_addresses: List of IPs that are excluded while allocating IP addresses to VM ports.
dynamic_ip_addresses: List of IPs, which are a subset from the reserved IP address list, that must be advertised to the SDN gateway.
network_function_chain_reference: UUID of the Network function chain entity that this subnet belongs to (type VLAN only).
bridge_name: Name of the bridge on the host for the subnet.
is_advanced_networking: Indicates whether the subnet is used for advanced networking.
cluster_name: Cluster Name
hypervisor_type: Hypervisor Type
virtual_switch: Schema to configure a virtual switch
vpc: Networking common base object
ip_prefix: IP Prefix in CIDR format.
ip_usage: IP usage statistics.
migration_state: Migration state of the subnet. This field is read-only.
links: 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.

dhcp_options

domain_name_servers: List of Domain Name Server addresses.
domain_name: The DNS domain name of the client.
search_domains: The DNS domain search list.
tftp_server_name: TFTP server name
boot_file_name: Boot file name
ntp_servers: List of NTP server addresses

domain_name_servers, ntp_servers

ipv4: IPv4 Object
ipv6: IPv6 Object

ip_config

ipv4: IP V4 configuration.
ipv6: IP V6 configuration

ip_config.ipv4, ip_config.ipv6

ip_subnet: subnet ip
default_gateway_ip: Reference to address configuration
dhcp_server_address: Reference to address configuration
pool_list: Pool of IP addresses from where IPs are allocated.

ip_subnet

ip: Reference to address configuration
prefix_length: The prefix length of the network to which this host IPv4 address belongs.

pool_list

start_ip: Reference to address configuration
end_ip: Reference to address configuration

ip_usage

num_macs: Number of MAC addresses.
num_free_ips: Number of free IPs.
num_assigned_ips: Number of assigned IPs.
ip_pool_usages: IP Pool usages

ip_pool_usages

num_free_ips: Number of free IPs
num_total_ips: Total number of IPs in this pool.
range: Start/end IP address range.

ipv4, ipv6 (Reference to address configuration)

value: value of address
prefix_length: The prefix length of the network to which this host IPv4/IPv6 address belongs.

See detailed information in Nutanix List Subnets v4.

Using getSubnetsV2

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 getSubnetsV2(args: GetSubnetsV2Args, opts?: InvokeOptions): Promise<GetSubnetsV2Result>
function getSubnetsV2Output(args: GetSubnetsV2OutputArgs, opts?: InvokeOptions): Output<GetSubnetsV2Result>

def get_subnets_v2(expand: Optional[str] = None,
                   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) -> GetSubnetsV2Result
def get_subnets_v2_output(expand: Optional[pulumi.Input[str]] = None,
                   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[GetSubnetsV2Result]

func GetSubnetsV2(ctx *Context, args *GetSubnetsV2Args, opts ...InvokeOption) (*GetSubnetsV2Result, error)
func GetSubnetsV2Output(ctx *Context, args *GetSubnetsV2OutputArgs, opts ...InvokeOption) GetSubnetsV2ResultOutput

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

public static class GetSubnetsV2 
{
    public static Task<GetSubnetsV2Result> InvokeAsync(GetSubnetsV2Args args, InvokeOptions? opts = null)
    public static Output<GetSubnetsV2Result> Invoke(GetSubnetsV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubnetsV2Result> getSubnetsV2(GetSubnetsV2Args args, InvokeOptions options)
public static Output<GetSubnetsV2Result> getSubnetsV2(GetSubnetsV2Args args, InvokeOptions options)

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

The following arguments are supported:

Expand string

A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. The expand can be applied to the following fields:

virtualSwitch

Filter string

A URL query parameter that allows clients to filter a collection of resources. The filter can be applied to the following fields:

clusterReference
extId
isExternal

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. The orderby can be applied to the following fields:

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. The select can be applied to the following fields:

clusterName
clusterReference
extId
hypervisorType
subnetType
ipPrefix
isAdvancedNetworking
isExternal
isNatEnabled

Expand string

A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. The expand can be applied to the following fields:

virtualSwitch

Filter string

A URL query parameter that allows clients to filter a collection of resources. The filter can be applied to the following fields:

clusterReference
extId
isExternal

Limit int

OrderBy string

Page int

Select string

A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. The select can be applied to the following fields:

clusterName
clusterReference
extId
hypervisorType
subnetType
ipPrefix
isAdvancedNetworking
isExternal
isNatEnabled

expand String

A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. The expand can be applied to the following fields:

virtualSwitch

filter String

A URL query parameter that allows clients to filter a collection of resources. The filter can be applied to the following fields:

clusterReference
extId
isExternal

limit Integer

orderBy String

page Integer

select String

A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. The select can be applied to the following fields:

clusterName
clusterReference
extId
hypervisorType
subnetType
ipPrefix
isAdvancedNetworking
isExternal
isNatEnabled

expand string

A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. The expand can be applied to the following fields:

virtualSwitch

filter string

A URL query parameter that allows clients to filter a collection of resources. The filter can be applied to the following fields:

clusterReference
extId
isExternal

limit number

orderBy string

page number

select string

A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. The select can be applied to the following fields:

clusterName
clusterReference
extId
hypervisorType
subnetType
ipPrefix
isAdvancedNetworking
isExternal
isNatEnabled

expand str

A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. The expand can be applied to the following fields:

virtualSwitch

filter str

A URL query parameter that allows clients to filter a collection of resources. The filter can be applied to the following fields:

clusterReference
extId
isExternal

limit int

order_by str

page int

select str

A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. The select can be applied to the following fields:

clusterName
clusterReference
extId
hypervisorType
subnetType
ipPrefix
isAdvancedNetworking
isExternal
isNatEnabled

expand String

A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. The expand can be applied to the following fields:

virtualSwitch

filter String

A URL query parameter that allows clients to filter a collection of resources. The filter can be applied to the following fields:

clusterReference
extId
isExternal

limit Number

orderBy String

page Number

select String

A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. The select can be applied to the following fields: