packet.ReservedIpBlock

Provides a resource to create and manage blocks of reserved IP addresses in a project.

When a user provisions first device in a facility, Packet API automatically allocates IPv6/56 and private IPv4/25 blocks. The new device then gets IPv6 and private IPv4 addresses from those block. It also gets a public IPv4/31 address. Every new device in the project and facility will automatically get IPv6 and private IPv4 addresses from these pre-allocated blocks. The IPv6 and private IPv4 blocks can’t be created, only imported. With this resource, it’s possible to create either public IPv4 blocks or global IPv4 blocks.

Public blocks are allocated in a facility. Addresses from public blocks can only be assigned to devices in the facility. Public blocks can have mask from /24 (256 addresses) to /32 (1 address). If you create public block with this resource, you must fill the facility argmument.

Addresses from global blocks can be assigned in any facility. Global blocks can have mask from /30 (4 addresses), to /32 (1 address). If you create global block with this resource, you must specify type = “global_ipv4” and you must omit the facility argument.

Once IP block is allocated or imported, an address from it can be assigned to device with the packet.IpAttachment resource.

Create ReservedIpBlock Resource

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

Constructor syntax

new ReservedIpBlock(name: string, args: ReservedIpBlockArgs, opts?: CustomResourceOptions);

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

@overload
def ReservedIpBlock(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    project_id: Optional[str] = None,
                    quantity: Optional[int] = None,
                    description: Optional[str] = None,
                    facility: Optional[str] = None,
                    type: Optional[str] = None)

func NewReservedIpBlock(ctx *Context, name string, args ReservedIpBlockArgs, opts ...ResourceOption) (*ReservedIpBlock, error)

public ReservedIpBlock(string name, ReservedIpBlockArgs args, CustomResourceOptions? opts = null)

public ReservedIpBlock(String name, ReservedIpBlockArgs args)
public ReservedIpBlock(String name, ReservedIpBlockArgs args, CustomResourceOptions options)

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

Parameters

Constructor example

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

var reservedIpBlockResource = new Packet.ReservedIpBlock("reservedIpBlockResource", new()
{
    ProjectId = "string",
    Quantity = 0,
    Description = "string",
    Facility = "string",
    Type = "string",
});

example, err := packet.NewReservedIpBlock(ctx, "reservedIpBlockResource", &packet.ReservedIpBlockArgs{
ProjectId: pulumi.String("string"),
Quantity: pulumi.Int(0),
Description: pulumi.String("string"),
Facility: pulumi.String("string"),
Type: pulumi.String("string"),
})

var reservedIpBlockResource = new ReservedIpBlock("reservedIpBlockResource", ReservedIpBlockArgs.builder()
    .projectId("string")
    .quantity(0)
    .description("string")
    .facility("string")
    .type("string")
    .build());

reserved_ip_block_resource = packet.ReservedIpBlock("reservedIpBlockResource",
    project_id="string",
    quantity=0,
    description="string",
    facility="string",
    type="string")

const reservedIpBlockResource = new packet.ReservedIpBlock("reservedIpBlockResource", {
    projectId: "string",
    quantity: 0,
    description: "string",
    facility: "string",
    type: "string",
});

type: packet:ReservedIpBlock
properties:
    description: string
    facility: string
    projectId: string
    quantity: 0
    type: string

ReservedIpBlock Resource Properties

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

Inputs

The ReservedIpBlock resource accepts the following input properties:

Outputs

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

Look up Existing ReservedIpBlock Resource

Get an existing ReservedIpBlock 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?: ReservedIpBlockState, opts?: CustomResourceOptions): ReservedIpBlock

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        address_family: Optional[int] = None,
        cidr: Optional[int] = None,
        cidr_notation: Optional[str] = None,
        description: Optional[str] = None,
        facility: Optional[str] = None,
        gateway: Optional[str] = None,
        global_: Optional[bool] = None,
        manageable: Optional[bool] = None,
        management: Optional[bool] = None,
        netmask: Optional[str] = None,
        network: Optional[str] = None,
        project_id: Optional[str] = None,
        public: Optional[bool] = None,
        quantity: Optional[int] = None,
        type: Optional[str] = None) -> ReservedIpBlock

func GetReservedIpBlock(ctx *Context, name string, id IDInput, state *ReservedIpBlockState, opts ...ResourceOption) (*ReservedIpBlock, error)

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

public static ReservedIpBlock get(String name, Output<String> id, ReservedIpBlockState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

Package Details

Repository

Packet pulumi/pulumi-packet

License

Apache-2.0

Notes

This Pulumi package is based on the packet Terraform Provider.