Skip to main content
Retrieves the default network and its default subnet for a specified project.

Example Usage

Schema

Required

  • parent_id (String) ID of the parent project.

Optional

  • network (Attributes) :

    Inner value description

    Defines a Network, which serves as a virtual representation of a traditional LAN within a cloud environment. Networks facilitate communication between subnets. (see below for nested schema)
  • subnet (Attributes) :

    Inner value description

    Defines a Subnet, a segment of a network used for more granular control and management. Subnet uses pools to organize address space. (see below for nested schema)

Nested Schema for network

Optional:

Nested Schema for network.metadata

Optional:
  • id (String) Identifier for the resource, unique for its resource type.
  • labels (Map of String) Labels associated with the resource.
  • name (String) Human-readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
Read-Only:
  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

Nested Schema for network.spec

Optional:

Nested Schema for network.spec.ipv4_private_pools

Optional:

Nested Schema for network.spec.ipv4_private_pools.pools

Optional:
  • id (String) ID of the pool.

Nested Schema for network.spec.ipv4_public_pools

Optional:

Nested Schema for network.spec.ipv4_public_pools.pools

Optional:
  • id (String) ID of the pool.

Nested Schema for network.status

Optional:
  • default (Boolean) Indicates whether this is the project’s default network.
  • default_route_table_id (String) ID of the network’s default route table.
  • state (String) : Current state of the network.

    Supported values

    Enumeration of possible states of the network. Possible values:
    • STATE_UNSPECIFIED - Default state, unspecified.
    • CREATING - Network is being created.
    • READY - Network is ready for use.
    • DELETING - Network is being deleted.

Nested Schema for subnet

Optional:

Nested Schema for subnet.metadata

Optional:
  • id (String) Identifier for the resource, unique for its resource type.
  • labels (Map of String) Labels associated with the resource.
  • name (String) Human-readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
Read-Only:
  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

Nested Schema for subnet.spec

Optional:
  • ipv4_private_pools (Attributes) : Private IPv4 address pools for this subnet. If unspecified, pools from the associated network are used. (see below for nested schema)
  • ipv4_public_pools (Attributes) : Public IPv4 address pools for this subnet. If unspecified, pools from the associated network are used. (see below for nested schema)
  • network_id (String) ID of the network this subnet belongs to.
  • route_table_id (String) : ID of the route table to associate with the subnet. If unspecified, the network’s default route table is used.

Nested Schema for subnet.spec.ipv4_private_pools

Optional:
  • pools (Attributes List) : List of private IPv4 CIDR blocks for this subnet. Must not overlap with other resources in the network Must be empty if use_network_pools is true. (see below for nested schema)
  • use_network_pools (Boolean) : If true, inherit private IPv4 pools from the network. Defaults to true. Must be false if pools is specified.

Nested Schema for subnet.spec.ipv4_private_pools.pools

Optional:

Nested Schema for subnet.spec.ipv4_private_pools.pools.cidrs

Optional:
  • cidr (String) : A CIDR block (e.g., “10.1.2.0/24”) or a prefix length (e.g., “/24”). If prefix length is specified, the CIDR block will be auto-allocated from the network’s available space.
  • max_mask_length (Number) Maximum mask length for an allocation from this block. Defaults to /32 for IPv4.
  • state (String) : Controls provisioning of IP addresses from the CIDR block. Defaults to AVAILABLE.

    Supported values

    Controls provisioning of IP addresses from this pool to other pools or allocations. Defaults to AVAILABLE. Possible values:
    • STATE_UNSPECIFIED - Not used, mandated by the protocol.
    • AVAILABLE - Default state. Provision of the IP addresses from this CIDR block is allowed.
    • DISABLED - Provision of the IP addresses from this CIDR block is denied.

Nested Schema for subnet.spec.ipv4_public_pools

Optional:
  • pools (Attributes List) : List of public IPv4 CIDR blocks for this subnet. Must not overlap with other resources in the network. Must be empty if use_network_pools is true. (see below for nested schema)
  • use_network_pools (Boolean) : If true, inherit public IPv4 pools from the network. Must be false if pools is specified.

Nested Schema for subnet.spec.ipv4_public_pools.pools

Optional:

Nested Schema for subnet.spec.ipv4_public_pools.pools.cidrs

Optional:
  • cidr (String) : A CIDR block (e.g., “10.1.2.0/24”) or a prefix length (e.g., “/24”). If prefix length is specified, the CIDR block will be auto-allocated from the network’s available space.
  • max_mask_length (Number) Maximum mask length for an allocation from this block. Defaults to /32 for IPv4.
  • state (String) : Controls provisioning of IP addresses from the CIDR block. Defaults to AVAILABLE.

    Supported values

    Controls provisioning of IP addresses from this pool to other pools or allocations. Defaults to AVAILABLE. Possible values:
    • STATE_UNSPECIFIED - Not used, mandated by the protocol.
    • AVAILABLE - Default state. Provision of the IP addresses from this CIDR block is allowed.
    • DISABLED - Provision of the IP addresses from this CIDR block is denied.

Nested Schema for subnet.status

Optional:
  • default (Boolean) Indicates whether this is the network’s default subnet.
  • ipv4_private_cidrs (List of String, Deprecated) : CIDR blocks. Deprecated: Use ipv4_private_pools.cidrs instead.
  • ipv4_private_pools (Attributes List) Private IPv4 pools available for allocations in this subnet. (see below for nested schema)
  • ipv4_public_cidrs (List of String, Deprecated) : CIDR blocks. Deprecated: Use ipv4_public_pools.cidrs instead.
  • ipv4_public_pools (Attributes List) Public IPv4 pools available for allocations in this subnet. (see below for nested schema)
  • route_table (Attributes) : Information about the route table associated with this subnet. Can be either a custom route table or the network’s default route table. (see below for nested schema)
  • state (String) : Current state of the subnet.

    Supported values

    Enumeration of possible states of the subnet. Possible values:
    • STATE_UNSPECIFIED - Default state, unspecified.
    • CREATING - Subnet is being created.
    • READY - Subnet is ready for use.
    • DELETING - Subnet is being deleted.

Nested Schema for subnet.status.ipv4_private_pools

Optional:
  • cidrs (List of String) CIDR blocks sourced from this pool.
  • pool_id (String) ID of the pool available for allocations in this subnet.

Nested Schema for subnet.status.ipv4_public_pools

Optional:
  • cidrs (List of String) CIDR blocks sourced from this pool.
  • pool_id (String) ID of the pool available for allocations in this subnet.

Nested Schema for subnet.status.route_table

Optional:
  • default (Boolean) : Indicates whether this is the network’s default route table. If true, this is the default route table inherited from the network. If false, this is a custom route table explicitly associated with the subnet via spec.
  • id (String) ID of the route table.