Proxmox Virtual Environment (Proxmox VE)

Community
Package contributed by a community member
v2.0.0 published on Friday, Jul 15, 2022 by Daniel Muehlbachler-Pietrzykowski

Container

Create a Container Resource

new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);
@overload
def Container(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              clone: Optional[_ct.ContainerCloneArgs] = None,
              console: Optional[_ct.ContainerConsoleArgs] = None,
              cpu: Optional[_ct.ContainerCpuArgs] = None,
              description: Optional[str] = None,
              disk: Optional[_ct.ContainerDiskArgs] = None,
              initialization: Optional[_ct.ContainerInitializationArgs] = None,
              memory: Optional[_ct.ContainerMemoryArgs] = None,
              network_interfaces: Optional[Sequence[_ct.ContainerNetworkInterfaceArgs]] = None,
              node_name: Optional[str] = None,
              operating_system: Optional[_ct.ContainerOperatingSystemArgs] = None,
              pool_id: Optional[str] = None,
              started: Optional[bool] = None,
              template: Optional[bool] = None,
              vm_id: Optional[int] = None)
@overload
def Container(resource_name: str,
              args: ContainerArgs,
              opts: Optional[ResourceOptions] = None)
func NewContainer(ctx *Context, name string, args ContainerArgs, opts ...ResourceOption) (*Container, error)
public Container(string name, ContainerArgs args, CustomResourceOptions? opts = null)
public Container(String name, ContainerArgs args)
public Container(String name, ContainerArgs args, CustomResourceOptions options)
type: proxmoxve:CT:Container
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ContainerArgs
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 ContainerArgs
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 ContainerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ContainerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ContainerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Container 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 Container resource accepts the following input properties:

NodeName string

The node name

Clone Pulumi.ProxmoxVE.CT.Inputs.ContainerCloneArgs

The cloning configuration

Console Pulumi.ProxmoxVE.CT.Inputs.ContainerConsoleArgs

The console configuration

Cpu Pulumi.ProxmoxVE.CT.Inputs.ContainerCpuArgs

The CPU allocation

Description string

The description

Disk Pulumi.ProxmoxVE.CT.Inputs.ContainerDiskArgs

The disks

Initialization Pulumi.ProxmoxVE.CT.Inputs.ContainerInitializationArgs

The initialization configuration

Memory Pulumi.ProxmoxVE.CT.Inputs.ContainerMemoryArgs

The memory allocation

NetworkInterfaces List<Pulumi.ProxmoxVE.CT.Inputs.ContainerNetworkInterfaceArgs>

The network interfaces

OperatingSystem Pulumi.ProxmoxVE.CT.Inputs.ContainerOperatingSystemArgs

The operating system configuration

PoolId string

The ID of the pool to assign the container to

Started bool

Whether to start the container

Template bool

Whether to create a template

VmId int

The VM identifier

NodeName string

The node name

Clone ContainerCloneArgs

The cloning configuration

Console ContainerConsoleArgs

The console configuration

Cpu ContainerCpuArgs

The CPU allocation

Description string

The description

Disk ContainerDiskArgs

The disks

Initialization ContainerInitializationArgs

The initialization configuration

Memory ContainerMemoryArgs

The memory allocation

NetworkInterfaces []ContainerNetworkInterfaceArgs

The network interfaces

OperatingSystem ContainerOperatingSystemArgs

The operating system configuration

PoolId string

The ID of the pool to assign the container to

Started bool

Whether to start the container

Template bool

Whether to create a template

VmId int

The VM identifier

nodeName String

The node name

clone_ ContainerCloneArgs

The cloning configuration

console ContainerConsoleArgs

The console configuration

cpu ContainerCpuArgs

The CPU allocation

description String

The description

disk ContainerDiskArgs

The disks

initialization ContainerInitializationArgs

The initialization configuration

memory ContainerMemoryArgs

The memory allocation

networkInterfaces List<ContainerNetworkInterfaceArgs>

The network interfaces

operatingSystem ContainerOperatingSystemArgs

The operating system configuration

poolId String

The ID of the pool to assign the container to

started Boolean

Whether to start the container

template Boolean

Whether to create a template

vmId Integer

The VM identifier

nodeName string

The node name

clone ContainerCloneArgs

The cloning configuration

console ContainerConsoleArgs

The console configuration

cpu ContainerCpuArgs

The CPU allocation

description string

The description

disk ContainerDiskArgs

The disks

initialization ContainerInitializationArgs

The initialization configuration

memory ContainerMemoryArgs

The memory allocation

networkInterfaces ContainerNetworkInterfaceArgs[]

The network interfaces

operatingSystem ContainerOperatingSystemArgs

The operating system configuration

poolId string

The ID of the pool to assign the container to

started boolean

Whether to start the container

template boolean

Whether to create a template

vmId number

The VM identifier

node_name str

The node name

clone ContainerCloneArgs

The cloning configuration

console ContainerConsoleArgs

The console configuration

cpu ContainerCpuArgs

The CPU allocation

description str

The description

disk ContainerDiskArgs

The disks

initialization ContainerInitializationArgs

The initialization configuration

memory ContainerMemoryArgs

The memory allocation

network_interfaces ContainerNetworkInterfaceArgs]

The network interfaces

operating_system ContainerOperatingSystemArgs

The operating system configuration

pool_id str

The ID of the pool to assign the container to

started bool

Whether to start the container

template bool

Whether to create a template

vm_id int

The VM identifier

nodeName String

The node name

clone Property Map

The cloning configuration

console Property Map

The console configuration

cpu Property Map

The CPU allocation

description String

The description

disk Property Map

The disks

initialization Property Map

The initialization configuration

memory Property Map

The memory allocation

networkInterfaces List<Property Map>

The network interfaces

operatingSystem Property Map

The operating system configuration

poolId String

The ID of the pool to assign the container to

started Boolean

Whether to start the container

template Boolean

Whether to create a template

vmId Number

The VM identifier

Outputs

All input properties are implicitly available as output properties. Additionally, the Container 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 an Existing Container Resource

Get an existing Container 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?: ContainerState, opts?: CustomResourceOptions): Container
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clone: Optional[_ct.ContainerCloneArgs] = None,
        console: Optional[_ct.ContainerConsoleArgs] = None,
        cpu: Optional[_ct.ContainerCpuArgs] = None,
        description: Optional[str] = None,
        disk: Optional[_ct.ContainerDiskArgs] = None,
        initialization: Optional[_ct.ContainerInitializationArgs] = None,
        memory: Optional[_ct.ContainerMemoryArgs] = None,
        network_interfaces: Optional[Sequence[_ct.ContainerNetworkInterfaceArgs]] = None,
        node_name: Optional[str] = None,
        operating_system: Optional[_ct.ContainerOperatingSystemArgs] = None,
        pool_id: Optional[str] = None,
        started: Optional[bool] = None,
        template: Optional[bool] = None,
        vm_id: Optional[int] = None) -> Container
func GetContainer(ctx *Context, name string, id IDInput, state *ContainerState, opts ...ResourceOption) (*Container, error)
public static Container Get(string name, Input<string> id, ContainerState? state, CustomResourceOptions? opts = null)
public static Container get(String name, Output<String> id, ContainerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Clone Pulumi.ProxmoxVE.CT.Inputs.ContainerCloneArgs

The cloning configuration

Console Pulumi.ProxmoxVE.CT.Inputs.ContainerConsoleArgs

The console configuration

Cpu Pulumi.ProxmoxVE.CT.Inputs.ContainerCpuArgs

The CPU allocation

Description string

The description

Disk Pulumi.ProxmoxVE.CT.Inputs.ContainerDiskArgs

The disks

Initialization Pulumi.ProxmoxVE.CT.Inputs.ContainerInitializationArgs

The initialization configuration

Memory Pulumi.ProxmoxVE.CT.Inputs.ContainerMemoryArgs

The memory allocation

NetworkInterfaces List<Pulumi.ProxmoxVE.CT.Inputs.ContainerNetworkInterfaceArgs>

The network interfaces

NodeName string

The node name

OperatingSystem Pulumi.ProxmoxVE.CT.Inputs.ContainerOperatingSystemArgs

The operating system configuration

PoolId string

The ID of the pool to assign the container to

Started bool

Whether to start the container

Template bool

Whether to create a template

VmId int

The VM identifier

Clone ContainerCloneArgs

The cloning configuration

Console ContainerConsoleArgs

The console configuration

Cpu ContainerCpuArgs

The CPU allocation

Description string

The description

Disk ContainerDiskArgs

The disks

Initialization ContainerInitializationArgs

The initialization configuration

Memory ContainerMemoryArgs

The memory allocation

NetworkInterfaces []ContainerNetworkInterfaceArgs

The network interfaces

NodeName string

The node name

OperatingSystem ContainerOperatingSystemArgs

The operating system configuration

PoolId string

The ID of the pool to assign the container to

Started bool

Whether to start the container

Template bool

Whether to create a template

VmId int

The VM identifier

clone_ ContainerCloneArgs

The cloning configuration

console ContainerConsoleArgs

The console configuration

cpu ContainerCpuArgs

The CPU allocation

description String

The description

disk ContainerDiskArgs

The disks

initialization ContainerInitializationArgs

The initialization configuration

memory ContainerMemoryArgs

The memory allocation

networkInterfaces List<ContainerNetworkInterfaceArgs>

The network interfaces

nodeName String

The node name

operatingSystem ContainerOperatingSystemArgs

The operating system configuration

poolId String

The ID of the pool to assign the container to

started Boolean

Whether to start the container

template Boolean

Whether to create a template

vmId Integer

The VM identifier

clone ContainerCloneArgs

The cloning configuration

console ContainerConsoleArgs

The console configuration

cpu ContainerCpuArgs

The CPU allocation

description string

The description

disk ContainerDiskArgs

The disks

initialization ContainerInitializationArgs

The initialization configuration

memory ContainerMemoryArgs

The memory allocation

networkInterfaces ContainerNetworkInterfaceArgs[]

The network interfaces

nodeName string

The node name

operatingSystem ContainerOperatingSystemArgs

The operating system configuration

poolId string

The ID of the pool to assign the container to

started boolean

Whether to start the container

template boolean

Whether to create a template

vmId number

The VM identifier

clone ContainerCloneArgs

The cloning configuration

console ContainerConsoleArgs

The console configuration

cpu ContainerCpuArgs

The CPU allocation

description str

The description

disk ContainerDiskArgs

The disks

initialization ContainerInitializationArgs

The initialization configuration

memory ContainerMemoryArgs

The memory allocation

network_interfaces ContainerNetworkInterfaceArgs]

The network interfaces

node_name str

The node name

operating_system ContainerOperatingSystemArgs

The operating system configuration

pool_id str

The ID of the pool to assign the container to

started bool

Whether to start the container

template bool

Whether to create a template

vm_id int

The VM identifier

clone Property Map

The cloning configuration

console Property Map

The console configuration

cpu Property Map

The CPU allocation

description String

The description

disk Property Map

The disks

initialization Property Map

The initialization configuration

memory Property Map

The memory allocation

networkInterfaces List<Property Map>

The network interfaces

nodeName String

The node name

operatingSystem Property Map

The operating system configuration

poolId String

The ID of the pool to assign the container to

started Boolean

Whether to start the container

template Boolean

Whether to create a template

vmId Number

The VM identifier

Supporting Types

ContainerClone

VmId int
DatastoreId string
NodeName string
VmId int
DatastoreId string
NodeName string
vmId Integer
datastoreId String
nodeName String
vmId number
datastoreId string
nodeName string
vmId Number
datastoreId String
nodeName String

ContainerConsole

Enabled bool
TtyCount int
Type string
Enabled bool
TtyCount int
Type string
enabled Boolean
ttyCount Integer
type String
enabled boolean
ttyCount number
type string
enabled Boolean
ttyCount Number
type String

ContainerCpu

Architecture string
Cores int
Units int
Architecture string
Cores int
Units int
architecture String
cores Integer
units Integer
architecture string
cores number
units number
architecture String
cores Number
units Number

ContainerDisk

ContainerInitialization

ContainerInitializationDns

Domain string
Server string
Domain string
Server string
domain String
server String
domain string
server string
domain str
server str
domain String
server String

ContainerInitializationIpConfig

ContainerInitializationIpConfigIpv4

Address string
Gateway string
Address string
Gateway string
address String
gateway String
address string
gateway string
address String
gateway String

ContainerInitializationIpConfigIpv6

Address string
Gateway string
Address string
Gateway string
address String
gateway String
address string
gateway string
address String
gateway String

ContainerInitializationUserAccount

Keys List<string>
Password string
Keys []string
Password string
keys List<String>
password String
keys string[]
password string
keys Sequence[str]
password str
keys List<String>
password String

ContainerMemory

dedicated Integer
swap Integer
dedicated number
swap number
dedicated Number
swap Number

ContainerNetworkInterface

Name string
Bridge string
Enabled bool
MacAddress string
RateLimit double
VlanId int
Name string
Bridge string
Enabled bool
MacAddress string
RateLimit float64
VlanId int
name String
bridge String
enabled Boolean
macAddress String
rateLimit Double
vlanId Integer
name string
bridge string
enabled boolean
macAddress string
rateLimit number
vlanId number
name String
bridge String
enabled Boolean
macAddress String
rateLimit Number
vlanId Number

ContainerOperatingSystem

TemplateFileId string
Type string
TemplateFileId string
Type string
templateFileId String
type String
templateFileId string
type string
templateFileId String
type String

Package Details

Repository
https://github.com/muhlba91/pulumi-proxmoxve
License
Apache-2.0
Notes

This Pulumi package is based on the proxmoxve Terraform Provider.