1. Packages
  2. Packages
  3. Lxd Provider
  4. API Docs
  5. Provider
Viewing docs for lxd 3.0.2
published on Monday, Jun 29, 2026 by terraform-lxd
Viewing docs for lxd 3.0.2
published on Monday, Jun 29, 2026 by terraform-lxd

    The provider type for the lxd 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

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

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 default_remote: Optional[str] = None,
                 remotes: Optional[Sequence[ProviderRemoteArgs]] = 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:lxd
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumi_lxd" "name" {
        # resource properties
    }

    Parameters

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    DefaultRemote string
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    Remotes List<ProviderRemote>
    LXD Remote
    DefaultRemote string
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    Remotes []ProviderRemoteArgs
    LXD Remote
    default_remote string
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    remotes list(object)
    LXD Remote
    defaultRemote String
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    remotes List<ProviderRemote>
    LXD Remote
    defaultRemote string
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    remotes ProviderRemote[]
    LXD Remote
    default_remote str
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    remotes Sequence[ProviderRemoteArgs]
    LXD Remote
    defaultRemote String
    Name of the default LXD remote to use when no remote is specified in the resource. If two or more remotes are defined, one must be set as the default.
    remotes List<Property Map>
    LXD Remote

    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 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.

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<{[key: string]: any}>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (pulumi.MapOutput, error)
    public Output<ImmutableDictionary<string, object>> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result map(any)
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Supporting Types

    ProviderRemote, ProviderRemoteArgs

    Address string
    Address of the LXD or SimpleStreams remote.
    Name string
    Name of the LXD remote.
    BearerToken string
    Bearer token for authentication.
    BearerTokenFile string
    Path to the file containing the bearer token for authentication.
    ClientCertificate string
    PEM-encoded client certificate for mTLS authentication.
    ClientCertificateFile string
    Path to the PEM-encoded client certificate for mTLS authentication.
    ClientKey string
    PEM-encoded private key for mTLS authentication.
    ClientKeyFile string
    Path to the PEM-encoded private key for mTLS authentication.
    Protocol string
    Remote protocol
    ServerCertificateFingerprint string
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    TrustToken string
    The trust token used for initial authentication with the LXD remote.
    Address string
    Address of the LXD or SimpleStreams remote.
    Name string
    Name of the LXD remote.
    BearerToken string
    Bearer token for authentication.
    BearerTokenFile string
    Path to the file containing the bearer token for authentication.
    ClientCertificate string
    PEM-encoded client certificate for mTLS authentication.
    ClientCertificateFile string
    Path to the PEM-encoded client certificate for mTLS authentication.
    ClientKey string
    PEM-encoded private key for mTLS authentication.
    ClientKeyFile string
    Path to the PEM-encoded private key for mTLS authentication.
    Protocol string
    Remote protocol
    ServerCertificateFingerprint string
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    TrustToken string
    The trust token used for initial authentication with the LXD remote.
    address string
    Address of the LXD or SimpleStreams remote.
    name string
    Name of the LXD remote.
    bearer_token string
    Bearer token for authentication.
    bearer_token_file string
    Path to the file containing the bearer token for authentication.
    client_certificate string
    PEM-encoded client certificate for mTLS authentication.
    client_certificate_file string
    Path to the PEM-encoded client certificate for mTLS authentication.
    client_key string
    PEM-encoded private key for mTLS authentication.
    client_key_file string
    Path to the PEM-encoded private key for mTLS authentication.
    protocol string
    Remote protocol
    server_certificate_fingerprint string
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    trust_token string
    The trust token used for initial authentication with the LXD remote.
    address String
    Address of the LXD or SimpleStreams remote.
    name String
    Name of the LXD remote.
    bearerToken String
    Bearer token for authentication.
    bearerTokenFile String
    Path to the file containing the bearer token for authentication.
    clientCertificate String
    PEM-encoded client certificate for mTLS authentication.
    clientCertificateFile String
    Path to the PEM-encoded client certificate for mTLS authentication.
    clientKey String
    PEM-encoded private key for mTLS authentication.
    clientKeyFile String
    Path to the PEM-encoded private key for mTLS authentication.
    protocol String
    Remote protocol
    serverCertificateFingerprint String
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    trustToken String
    The trust token used for initial authentication with the LXD remote.
    address string
    Address of the LXD or SimpleStreams remote.
    name string
    Name of the LXD remote.
    bearerToken string
    Bearer token for authentication.
    bearerTokenFile string
    Path to the file containing the bearer token for authentication.
    clientCertificate string
    PEM-encoded client certificate for mTLS authentication.
    clientCertificateFile string
    Path to the PEM-encoded client certificate for mTLS authentication.
    clientKey string
    PEM-encoded private key for mTLS authentication.
    clientKeyFile string
    Path to the PEM-encoded private key for mTLS authentication.
    protocol string
    Remote protocol
    serverCertificateFingerprint string
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    trustToken string
    The trust token used for initial authentication with the LXD remote.
    address str
    Address of the LXD or SimpleStreams remote.
    name str
    Name of the LXD remote.
    bearer_token str
    Bearer token for authentication.
    bearer_token_file str
    Path to the file containing the bearer token for authentication.
    client_certificate str
    PEM-encoded client certificate for mTLS authentication.
    client_certificate_file str
    Path to the PEM-encoded client certificate for mTLS authentication.
    client_key str
    PEM-encoded private key for mTLS authentication.
    client_key_file str
    Path to the PEM-encoded private key for mTLS authentication.
    protocol str
    Remote protocol
    server_certificate_fingerprint str
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    trust_token str
    The trust token used for initial authentication with the LXD remote.
    address String
    Address of the LXD or SimpleStreams remote.
    name String
    Name of the LXD remote.
    bearerToken String
    Bearer token for authentication.
    bearerTokenFile String
    Path to the file containing the bearer token for authentication.
    clientCertificate String
    PEM-encoded client certificate for mTLS authentication.
    clientCertificateFile String
    Path to the PEM-encoded client certificate for mTLS authentication.
    clientKey String
    PEM-encoded private key for mTLS authentication.
    clientKeyFile String
    Path to the PEM-encoded private key for mTLS authentication.
    protocol String
    Remote protocol
    serverCertificateFingerprint String
    SHA-256 fingerprint of the remote server's TLS certificate. Used to pin and verify the server certificate.
    trustToken String
    The trust token used for initial authentication with the LXD remote.

    Package Details

    Repository
    lxd terraform-lxd/terraform-provider-lxd
    License
    Notes
    This Pulumi package is based on the lxd Terraform Provider.
    Viewing docs for lxd 3.0.2
    published on Monday, Jun 29, 2026 by terraform-lxd

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial