1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. DNS
Proxmox Virtual Environment (Proxmox VE) v6.3.0 published on Thursday, Apr 11, 2024 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.DNS

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.3.0 published on Thursday, Apr 11, 2024 by Daniel Muehlbachler-Pietrzykowski

    Manages the DNS configuration for a specific node.

    Create DNS Resource

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

    Constructor syntax

    new DNS(name: string, args: DNSArgs, opts?: CustomResourceOptions);
    @overload
    def DNS(resource_name: str,
            args: DNSArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def DNS(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            domain: Optional[str] = None,
            node_name: Optional[str] = None,
            servers: Optional[Sequence[str]] = None)
    func NewDNS(ctx *Context, name string, args DNSArgs, opts ...ResourceOption) (*DNS, error)
    public DNS(string name, DNSArgs args, CustomResourceOptions? opts = null)
    public DNS(String name, DNSArgs args)
    public DNS(String name, DNSArgs args, CustomResourceOptions options)
    
    type: proxmoxve:DNS
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var dnsResource = new ProxmoxVE.DNS("dnsResource", new()
    {
        Domain = "string",
        NodeName = "string",
        Servers = new[]
        {
            "string",
        },
    });
    
    example, err := proxmoxve.NewDNS(ctx, "dnsResource", &proxmoxve.DNSArgs{
    	Domain:   pulumi.String("string"),
    	NodeName: pulumi.String("string"),
    	Servers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var dnsResource = new DNS("dnsResource", DNSArgs.builder()        
        .domain("string")
        .nodeName("string")
        .servers("string")
        .build());
    
    dns_resource = proxmoxve.DNS("dnsResource",
        domain="string",
        node_name="string",
        servers=["string"])
    
    const dnsResource = new proxmoxve.DNS("dnsResource", {
        domain: "string",
        nodeName: "string",
        servers: ["string"],
    });
    
    type: proxmoxve:DNS
    properties:
        domain: string
        nodeName: string
        servers:
            - string
    

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

    Domain string
    The DNS search domain.
    NodeName string
    A node name.
    Servers List<string>
    The DNS servers.
    Domain string
    The DNS search domain.
    NodeName string
    A node name.
    Servers []string
    The DNS servers.
    domain String
    The DNS search domain.
    nodeName String
    A node name.
    servers List<String>
    The DNS servers.
    domain string
    The DNS search domain.
    nodeName string
    A node name.
    servers string[]
    The DNS servers.
    domain str
    The DNS search domain.
    node_name str
    A node name.
    servers Sequence[str]
    The DNS servers.
    domain String
    The DNS search domain.
    nodeName String
    A node name.
    servers List<String>
    The DNS servers.

    Outputs

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

    Get an existing DNS 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?: DNSState, opts?: CustomResourceOptions): DNS
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            domain: Optional[str] = None,
            node_name: Optional[str] = None,
            servers: Optional[Sequence[str]] = None) -> DNS
    func GetDNS(ctx *Context, name string, id IDInput, state *DNSState, opts ...ResourceOption) (*DNS, error)
    public static DNS Get(string name, Input<string> id, DNSState? state, CustomResourceOptions? opts = null)
    public static DNS get(String name, Output<String> id, DNSState 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:
    Domain string
    The DNS search domain.
    NodeName string
    A node name.
    Servers List<string>
    The DNS servers.
    Domain string
    The DNS search domain.
    NodeName string
    A node name.
    Servers []string
    The DNS servers.
    domain String
    The DNS search domain.
    nodeName String
    A node name.
    servers List<String>
    The DNS servers.
    domain string
    The DNS search domain.
    nodeName string
    A node name.
    servers string[]
    The DNS servers.
    domain str
    The DNS search domain.
    node_name str
    A node name.
    servers Sequence[str]
    The DNS servers.
    domain String
    The DNS search domain.
    nodeName String
    A node name.
    servers List<String>
    The DNS servers.

    Import

    Instances can be imported using the node_name, e.g.,

    bash

    $ pulumi import proxmoxve:index/dNS:DNS first_node first-node
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.3.0 published on Thursday, Apr 11, 2024 by Daniel Muehlbachler-Pietrzykowski