1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Provider
Proxmox Virtual Environment (Proxmox VE) v6.1.0 published on Sunday, Mar 24, 2024 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Provider

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.1.0 published on Sunday, Mar 24, 2024 by Daniel Muehlbachler-Pietrzykowski

    The provider type for the proxmox package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 api_token: Optional[str] = None,
                 endpoint: Optional[str] = None,
                 insecure: Optional[bool] = None,
                 min_tls: Optional[str] = None,
                 otp: Optional[str] = None,
                 password: Optional[str] = None,
                 ssh: Optional[ProviderSshArgs] = None,
                 tmp_dir: Optional[str] = None,
                 username: Optional[str] = None)
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:proxmoxve
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ApiToken string
    The API token for the Proxmox VE API.
    Endpoint string
    The endpoint for the Proxmox VE API.
    Insecure bool
    Whether to skip the TLS verification step.
    MinTls string
    The minimum required TLS version for API calls.Supported values: 1.0|1.1|1.2|1.3. Defaults to 1.3.
    Otp 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 api_token attribute instead.

    Password string
    The password for the Proxmox VE API.
    Ssh Pulumi.ProxmoxVE.Inputs.ProviderSsh
    The SSH configuration for the Proxmox nodes.
    TmpDir string
    The alternative temporary directory.
    Username string
    The username for the Proxmox VE API.
    ApiToken string
    The API token for the Proxmox VE API.
    Endpoint string
    The endpoint for the Proxmox VE API.
    Insecure bool
    Whether to skip the TLS verification step.
    MinTls string
    The minimum required TLS version for API calls.Supported values: 1.0|1.1|1.2|1.3. Defaults to 1.3.
    Otp 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 api_token attribute instead.

    Password string
    The password for the Proxmox VE API.
    Ssh ProviderSshArgs
    The SSH configuration for the Proxmox nodes.
    TmpDir string
    The alternative temporary directory.
    Username string
    The username for the Proxmox VE API.
    apiToken String
    The API token for the Proxmox VE API.
    endpoint String
    The endpoint for the Proxmox VE API.
    insecure Boolean
    Whether to skip the TLS verification step.
    minTls String
    The minimum required TLS version for API calls.Supported values: 1.0|1.1|1.2|1.3. Defaults to 1.3.
    otp 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 api_token attribute instead.

    password String
    The password for the Proxmox VE API.
    ssh ProviderSsh
    The SSH configuration for the Proxmox nodes.
    tmpDir String
    The alternative temporary directory.
    username String
    The username for the Proxmox VE API.
    apiToken string
    The API token for the Proxmox VE API.
    endpoint string
    The endpoint for the Proxmox VE API.
    insecure boolean
    Whether to skip the TLS verification step.
    minTls string
    The minimum required TLS version for API calls.Supported values: 1.0|1.1|1.2|1.3. Defaults to 1.3.
    otp 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 api_token attribute instead.

    password string
    The password for the Proxmox VE API.
    ssh ProviderSsh
    The SSH configuration for the Proxmox nodes.
    tmpDir string
    The alternative temporary directory.
    username string
    The username for the Proxmox VE API.
    api_token str
    The API token for the Proxmox VE API.
    endpoint str
    The endpoint for the Proxmox VE API.
    insecure bool
    Whether to skip the TLS verification step.
    min_tls str
    The minimum required TLS version for API calls.Supported values: 1.0|1.1|1.2|1.3. Defaults to 1.3.
    otp str
    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 api_token attribute instead.

    password str
    The password for the Proxmox VE API.
    ssh ProviderSshArgs
    The SSH configuration for the Proxmox nodes.
    tmp_dir str
    The alternative temporary directory.
    username str
    The username for the Proxmox VE API.
    apiToken String
    The API token for the Proxmox VE API.
    endpoint String
    The endpoint for the Proxmox VE API.
    insecure Boolean
    Whether to skip the TLS verification step.
    minTls String
    The minimum required TLS version for API calls.Supported values: 1.0|1.1|1.2|1.3. Defaults to 1.3.
    otp 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 api_token attribute instead.

    password String
    The password for the Proxmox VE API.
    ssh Property Map
    The SSH configuration for the Proxmox nodes.
    tmpDir String
    The alternative temporary directory.
    username String
    The username for the Proxmox VE API.

    Outputs

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

    Supporting Types

    ProviderSsh, ProviderSshArgs

    Agent bool
    Whether to use the SSH agent for authentication. Takes precedence over the private_key and password fields. Defaults to the value of the PROXMOX_VE_SSH_AGENT environment variable, or false if not set.
    AgentSocket string
    The path to the SSH agent socket. Defaults to the value of the SSH_AUTH_SOCK environment variable.
    Nodes List<Pulumi.ProxmoxVE.Inputs.ProviderSshNode>
    Overrides for SSH connection configuration for a Proxmox VE node.
    Password string
    The password used for the SSH connection. Defaults to the value of the password field of the provider block.
    PrivateKey string
    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.
    Socks5Password string
    The password for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_PASSWORD environment variable.
    Socks5Server string
    The address:port of the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_SERVER environment variable.
    Socks5Username string
    The username for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_USERNAME environment variable.
    Username string
    The username used for the SSH connection. Defaults to the value of the username field of the provider block.
    Agent bool
    Whether to use the SSH agent for authentication. Takes precedence over the private_key and password fields. Defaults to the value of the PROXMOX_VE_SSH_AGENT environment variable, or false if not set.
    AgentSocket string
    The path to the SSH agent socket. Defaults to the value of the SSH_AUTH_SOCK environment variable.
    Nodes []ProviderSshNode
    Overrides for SSH connection configuration for a Proxmox VE node.
    Password string
    The password used for the SSH connection. Defaults to the value of the password field of the provider block.
    PrivateKey string
    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.
    Socks5Password string
    The password for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_PASSWORD environment variable.
    Socks5Server string
    The address:port of the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_SERVER environment variable.
    Socks5Username string
    The username for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_USERNAME environment variable.
    Username string
    The username used for the SSH connection. Defaults to the value of the username field of the provider block.
    agent Boolean
    Whether to use the SSH agent for authentication. Takes precedence over the private_key and password fields. Defaults to the value of the PROXMOX_VE_SSH_AGENT environment variable, or false if not set.
    agentSocket String
    The path to the SSH agent socket. Defaults to the value of the SSH_AUTH_SOCK environment variable.
    nodes List<ProviderSshNode>
    Overrides for SSH connection configuration for a Proxmox VE node.
    password String
    The password used for the SSH connection. Defaults to the value of the password field of the provider block.
    privateKey String
    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.
    socks5Password String
    The password for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_PASSWORD environment variable.
    socks5Server String
    The address:port of the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_SERVER environment variable.
    socks5Username String
    The username for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_USERNAME environment variable.
    username String
    The username used for the SSH connection. Defaults to the value of the username field of the provider block.
    agent boolean
    Whether to use the SSH agent for authentication. Takes precedence over the private_key and password fields. Defaults to the value of the PROXMOX_VE_SSH_AGENT environment variable, or false if not set.
    agentSocket string
    The path to the SSH agent socket. Defaults to the value of the SSH_AUTH_SOCK environment variable.
    nodes ProviderSshNode[]
    Overrides for SSH connection configuration for a Proxmox VE node.
    password string
    The password used for the SSH connection. Defaults to the value of the password field of the provider block.
    privateKey string
    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.
    socks5Password string
    The password for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_PASSWORD environment variable.
    socks5Server string
    The address:port of the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_SERVER environment variable.
    socks5Username string
    The username for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_USERNAME environment variable.
    username string
    The username used for the SSH connection. Defaults to the value of the username field of the provider block.
    agent bool
    Whether to use the SSH agent for authentication. Takes precedence over the private_key and password fields. Defaults to the value of the PROXMOX_VE_SSH_AGENT environment variable, or false if not set.
    agent_socket str
    The path to the SSH agent socket. Defaults to the value of the SSH_AUTH_SOCK environment variable.
    nodes Sequence[ProviderSshNode]
    Overrides for SSH connection configuration for a Proxmox VE node.
    password str
    The password used for the SSH connection. Defaults to the value of the password field of the provider block.
    private_key str
    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.
    socks5_password str
    The password for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_PASSWORD environment variable.
    socks5_server str
    The address:port of the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_SERVER environment variable.
    socks5_username str
    The username for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_USERNAME environment variable.
    username str
    The username used for the SSH connection. Defaults to the value of the username field of the provider block.
    agent Boolean
    Whether to use the SSH agent for authentication. Takes precedence over the private_key and password fields. Defaults to the value of the PROXMOX_VE_SSH_AGENT environment variable, or false if not set.
    agentSocket String
    The path to the SSH agent socket. Defaults to the value of the SSH_AUTH_SOCK environment variable.
    nodes List<Property Map>
    Overrides for SSH connection configuration for a Proxmox VE node.
    password String
    The password used for the SSH connection. Defaults to the value of the password field of the provider block.
    privateKey String
    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.
    socks5Password String
    The password for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_PASSWORD environment variable.
    socks5Server String
    The address:port of the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_SERVER environment variable.
    socks5Username String
    The username for the SOCKS5 proxy server. Defaults to the value of the PROXMOX_VE_SSH_SOCKS5_USERNAME environment variable.
    username String
    The username used for the SSH connection. Defaults to the value of the username field of the provider block.

    ProviderSshNode, ProviderSshNodeArgs

    Address string
    The address of the Proxmox VE node.
    Name string
    The name of the Proxmox VE node.
    Port int
    The port of the Proxmox VE node.
    Address string
    The address of the Proxmox VE node.
    Name string
    The name of the Proxmox VE node.
    Port int
    The port of the Proxmox VE node.
    address String
    The address of the Proxmox VE node.
    name String
    The name of the Proxmox VE node.
    port Integer
    The port of the Proxmox VE node.
    address string
    The address of the Proxmox VE node.
    name string
    The name of the Proxmox VE node.
    port number
    The port of the Proxmox VE node.
    address str
    The address of the Proxmox VE node.
    name str
    The name of the Proxmox VE node.
    port int
    The port of the Proxmox VE node.
    address String
    The address of the Proxmox VE node.
    name String
    The name of the Proxmox VE node.
    port Number
    The port of the Proxmox VE node.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v6.1.0 published on Sunday, Mar 24, 2024 by Daniel Muehlbachler-Pietrzykowski