config

package
v6.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 21, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetApiToken 

func GetApiToken(ctx *pulumi.Context) string

The API token for the Proxmox VE API.

func GetEndpoint 

func GetEndpoint(ctx *pulumi.Context) string

The endpoint for the Proxmox VE API.

func GetInsecure 

func GetInsecure(ctx *pulumi.Context) bool

Whether to skip the TLS verification step.

func GetMinTls 

func GetMinTls(ctx *pulumi.Context) string

The minimum required TLS version for API calls.Supported values: `1.0|1.1|1.2|1.3`. Defaults to `1.3`.

func GetOtp deprecated 

func GetOtp(ctx *pulumi.Context) string

The one-time password for the Proxmox VE API.

Deprecated: The `otp` attribute is deprecated and will be removed in a future release. Please use the `apiToken` attribute instead.

func GetPassword 

func GetPassword(ctx *pulumi.Context) string

The password for the Proxmox VE API.

func GetSsh 

func GetSsh(ctx *pulumi.Context) string

The SSH configuration for the Proxmox nodes.

func GetTmpDir 

func GetTmpDir(ctx *pulumi.Context) string

The alternative temporary directory.

func GetUsername 

func GetUsername(ctx *pulumi.Context) string

The username for the Proxmox VE API.

Types

type Ssh 

type Ssh struct {
	// Whether to use the SSH agent for authentication. Takes precedence over the `privateKey` and `password` fields. Defaults to the value of the `PROXMOX_VE_SSH_AGENT` environment variable, or `false` if not set.
	Agent *bool `pulumi:"agent"`
	// The path to the SSH agent socket. Defaults to the value of the `SSH_AUTH_SOCK` environment variable.
	AgentSocket *string `pulumi:"agentSocket"`
	// Overrides for SSH connection configuration for a Proxmox VE node.
	Nodes []SshNode `pulumi:"nodes"`
	// The password used for the SSH connection. Defaults to the value of the `password` field of the `provider` block.
	Password *string `pulumi:"password"`
	// The unencrypted private key (in PEM format) used for the SSH connection. Defaults to the value of the `PROXMOX_VE_SSH_PRIVATE_KEY` environment variable.
	PrivateKey *string `pulumi:"privateKey"`
	// The password for the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_PASSWORD` environment variable.
	Socks5Password *string `pulumi:"socks5Password"`
	// The address:port of the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_SERVER` environment variable.
	Socks5Server *string `pulumi:"socks5Server"`
	// The username for the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_USERNAME` environment variable.
	Socks5Username *string `pulumi:"socks5Username"`
	// The username used for the SSH connection. Defaults to the value of the `username` field of the `provider` block.
	Username *string `pulumi:"username"`
}

type SshArgs 

type SshArgs struct {
	// Whether to use the SSH agent for authentication. Takes precedence over the `privateKey` and `password` fields. Defaults to the value of the `PROXMOX_VE_SSH_AGENT` environment variable, or `false` if not set.
	Agent pulumi.BoolPtrInput `pulumi:"agent"`
	// The path to the SSH agent socket. Defaults to the value of the `SSH_AUTH_SOCK` environment variable.
	AgentSocket pulumi.StringPtrInput `pulumi:"agentSocket"`
	// Overrides for SSH connection configuration for a Proxmox VE node.
	Nodes SshNodeArrayInput `pulumi:"nodes"`
	// The password used for the SSH connection. Defaults to the value of the `password` field of the `provider` block.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// The unencrypted private key (in PEM format) used for the SSH connection. Defaults to the value of the `PROXMOX_VE_SSH_PRIVATE_KEY` environment variable.
	PrivateKey pulumi.StringPtrInput `pulumi:"privateKey"`
	// The password for the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_PASSWORD` environment variable.
	Socks5Password pulumi.StringPtrInput `pulumi:"socks5Password"`
	// The address:port of the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_SERVER` environment variable.
	Socks5Server pulumi.StringPtrInput `pulumi:"socks5Server"`
	// The username for the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_USERNAME` environment variable.
	Socks5Username pulumi.StringPtrInput `pulumi:"socks5Username"`
	// The username used for the SSH connection. Defaults to the value of the `username` field of the `provider` block.
	Username pulumi.StringPtrInput `pulumi:"username"`
}

func (SshArgs) ElementType 

func (SshArgs) ElementType() reflect.Type

func (SshArgs) ToSshOutput 

func (i SshArgs) ToSshOutput() SshOutput

func (SshArgs) ToSshOutputWithContext 

func (i SshArgs) ToSshOutputWithContext(ctx context.Context) SshOutput

type SshInput 

type SshInput interface {
	pulumi.Input

	ToSshOutput() SshOutput
	ToSshOutputWithContext(context.Context) SshOutput
}

SshInput is an input type that accepts SshArgs and SshOutput values. You can construct a concrete instance of `SshInput` via: 

SshArgs{...}

type SshNode 

type SshNode struct {
	// The address of the Proxmox VE node.
	Address string `pulumi:"address"`
	// The name of the Proxmox VE node.
	Name string `pulumi:"name"`
	// The port of the Proxmox VE node.
	Port *int `pulumi:"port"`
}

type SshNodeArgs 

type SshNodeArgs struct {
	// The address of the Proxmox VE node.
	Address pulumi.StringInput `pulumi:"address"`
	// The name of the Proxmox VE node.
	Name pulumi.StringInput `pulumi:"name"`
	// The port of the Proxmox VE node.
	Port pulumi.IntPtrInput `pulumi:"port"`
}

func (SshNodeArgs) ElementType 

func (SshNodeArgs) ElementType() reflect.Type

func (SshNodeArgs) ToSshNodeOutput 

func (i SshNodeArgs) ToSshNodeOutput() SshNodeOutput

func (SshNodeArgs) ToSshNodeOutputWithContext 

func (i SshNodeArgs) ToSshNodeOutputWithContext(ctx context.Context) SshNodeOutput

type SshNodeArray 

type SshNodeArray []SshNodeInput

func (SshNodeArray) ElementType 

func (SshNodeArray) ElementType() reflect.Type

func (SshNodeArray) ToSshNodeArrayOutput 

func (i SshNodeArray) ToSshNodeArrayOutput() SshNodeArrayOutput

func (SshNodeArray) ToSshNodeArrayOutputWithContext 

func (i SshNodeArray) ToSshNodeArrayOutputWithContext(ctx context.Context) SshNodeArrayOutput

type SshNodeArrayInput 

type SshNodeArrayInput interface {
	pulumi.Input

	ToSshNodeArrayOutput() SshNodeArrayOutput
	ToSshNodeArrayOutputWithContext(context.Context) SshNodeArrayOutput
}

SshNodeArrayInput is an input type that accepts SshNodeArray and SshNodeArrayOutput values. You can construct a concrete instance of `SshNodeArrayInput` via: 

SshNodeArray{ SshNodeArgs{...} }

type SshNodeArrayOutput 

type SshNodeArrayOutput struct{ *pulumi.OutputState }

func (SshNodeArrayOutput) ElementType 

func (SshNodeArrayOutput) ElementType() reflect.Type

func (SshNodeArrayOutput) Index 

func (o SshNodeArrayOutput) Index(i pulumi.IntInput) SshNodeOutput

func (SshNodeArrayOutput) ToSshNodeArrayOutput 

func (o SshNodeArrayOutput) ToSshNodeArrayOutput() SshNodeArrayOutput

func (SshNodeArrayOutput) ToSshNodeArrayOutputWithContext 

func (o SshNodeArrayOutput) ToSshNodeArrayOutputWithContext(ctx context.Context) SshNodeArrayOutput

type SshNodeInput 

type SshNodeInput interface {
	pulumi.Input

	ToSshNodeOutput() SshNodeOutput
	ToSshNodeOutputWithContext(context.Context) SshNodeOutput
}

SshNodeInput is an input type that accepts SshNodeArgs and SshNodeOutput values. You can construct a concrete instance of `SshNodeInput` via: 

SshNodeArgs{...}

type SshNodeOutput 

type SshNodeOutput struct{ *pulumi.OutputState }

func (SshNodeOutput) Address 

func (o SshNodeOutput) Address() pulumi.StringOutput

The address of the Proxmox VE node.

func (SshNodeOutput) ElementType 

func (SshNodeOutput) ElementType() reflect.Type

func (SshNodeOutput) Name 

func (o SshNodeOutput) Name() pulumi.StringOutput

The name of the Proxmox VE node.

func (SshNodeOutput) Port 

func (o SshNodeOutput) Port() pulumi.IntPtrOutput

The port of the Proxmox VE node.

func (SshNodeOutput) ToSshNodeOutput 

func (o SshNodeOutput) ToSshNodeOutput() SshNodeOutput

func (SshNodeOutput) ToSshNodeOutputWithContext 

func (o SshNodeOutput) ToSshNodeOutputWithContext(ctx context.Context) SshNodeOutput

type SshOutput 

type SshOutput struct{ *pulumi.OutputState }

func (SshOutput) Agent 

func (o SshOutput) Agent() pulumi.BoolPtrOutput

Whether to use the SSH agent for authentication. Takes precedence over the `privateKey` and `password` fields. Defaults to the value of the `PROXMOX_VE_SSH_AGENT` environment variable, or `false` if not set.

func (SshOutput) AgentSocket 

func (o SshOutput) AgentSocket() pulumi.StringPtrOutput

The path to the SSH agent socket. Defaults to the value of the `SSH_AUTH_SOCK` environment variable.

func (SshOutput) ElementType 

func (SshOutput) ElementType() reflect.Type

func (SshOutput) Nodes 

func (o SshOutput) Nodes() SshNodeArrayOutput

Overrides for SSH connection configuration for a Proxmox VE node.

func (SshOutput) Password 

func (o SshOutput) Password() pulumi.StringPtrOutput

The password used for the SSH connection. Defaults to the value of the `password` field of the `provider` block.

func (SshOutput) PrivateKey 

func (o SshOutput) PrivateKey() pulumi.StringPtrOutput

The unencrypted private key (in PEM format) used for the SSH connection. Defaults to the value of the `PROXMOX_VE_SSH_PRIVATE_KEY` environment variable.

func (SshOutput) Socks5Password 

func (o SshOutput) Socks5Password() pulumi.StringPtrOutput

The password for the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_PASSWORD` environment variable.

func (SshOutput) Socks5Server 

func (o SshOutput) Socks5Server() pulumi.StringPtrOutput

The address:port of the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_SERVER` environment variable.

func (SshOutput) Socks5Username 

func (o SshOutput) Socks5Username() pulumi.StringPtrOutput

The username for the SOCKS5 proxy server. Defaults to the value of the `PROXMOX_VE_SSH_SOCKS5_USERNAME` environment variable.

func (SshOutput) ToSshOutput 

func (o SshOutput) ToSshOutput() SshOutput

func (SshOutput) ToSshOutputWithContext 

func (o SshOutput) ToSshOutputWithContext(ctx context.Context) SshOutput

func (SshOutput) Username 

func (o SshOutput) Username() pulumi.StringPtrOutput

The username used for the SSH connection. Defaults to the value of the `username` field of the `provider` block.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.