Docs Packages
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Hosts
Proxmox Virtual Environment (Proxmox VE) v6.10.1 published on Friday, Jun 28, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.Hosts

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.10.1 published on Friday, Jun 28, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

    Manages the host entries on a specific node.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  firstNodeHostEntries:
    type: proxmoxve:Hosts
    properties:
      entries:
        - address: 127.0.0.1
          hostnames:
            - localhost
            - localhost.localdomain
      nodeName: first-node

    Create Hosts Resource

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

    Constructor syntax

    new Hosts(name: string, args: HostsArgs, opts?: CustomResourceOptions);
    @overload
def Hosts(resource_name: str,
          args: HostsArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Hosts(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          entry: Optional[Sequence[HostsEntryArgs]] = None,
          node_name: Optional[str] = None)
    func NewHosts(ctx *Context, name string, args HostsArgs, opts ...ResourceOption) (*Hosts, error)
    public Hosts(string name, HostsArgs args, CustomResourceOptions? opts = null)
    public Hosts(String name, HostsArgs args)
public Hosts(String name, HostsArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var hostsResource = new ProxmoxVE.Hosts("hostsResource", new()
{
    Entry = new[]
    {
        new ProxmoxVE.Inputs.HostsEntryArgs
        {
            Address = "string",
            Hostnames = new[]
            {
                "string",
            },
        },
    },
    NodeName = "string",
});

    example, err := proxmoxve.NewHosts(ctx, "hostsResource", &proxmoxve.HostsArgs{
	Entry: proxmoxve.HostsEntryArray{
		&proxmoxve.HostsEntryArgs{
			Address: pulumi.String("string"),
			Hostnames: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	NodeName: pulumi.String("string"),
})

    var hostsResource = new Hosts("hostsResource", HostsArgs.builder()
    .entry(HostsEntryArgs.builder()
        .address("string")
        .hostnames("string")
        .build())
    .nodeName("string")
    .build());

    hosts_resource = proxmoxve.Hosts("hostsResource",
    entry=[proxmoxve.HostsEntryArgs(
        address="string",
        hostnames=["string"],
    )],
    node_name="string")

    const hostsResource = new proxmoxve.Hosts("hostsResource", {
    entry: [{
        address: "string",
        hostnames: ["string"],
    }],
    nodeName: "string",
});

    type: proxmoxve:Hosts
properties:
    entry:
        - address: string
          hostnames:
            - string
    nodeName: string

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

    Entry List<Pulumi.ProxmoxVE.Inputs.HostsEntry>
    A host entry (multiple blocks supported).
    NodeName string
    A node name.
    Entry []HostsEntryArgs
    A host entry (multiple blocks supported).
    NodeName string
    A node name.
    entry List<HostsEntry>
    A host entry (multiple blocks supported).
    nodeName String
    A node name.
    entry HostsEntry[]
    A host entry (multiple blocks supported).
    nodeName string
    A node name.
    entry Sequence[HostsEntryArgs]
    A host entry (multiple blocks supported).
    node_name str
    A node name.
    entry List<Property Map>
    A host entry (multiple blocks supported).
    nodeName String
    A node name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Hosts resource produces the following output properties:

    Addresses List<string>
    The IP addresses.
    Digest string
    The SHA1 digest.
    Entries List<Pulumi.ProxmoxVE.Outputs.HostsEntry>
    The host entries (conversion of addresses and hostnames into objects).
    Hostnames List<ImmutableArray<string>>
    The hostnames associated with each of the IP addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    Addresses []string
    The IP addresses.
    Digest string
    The SHA1 digest.
    Entries []HostsEntry
    The host entries (conversion of addresses and hostnames into objects).
    Hostnames [][]string
    The hostnames associated with each of the IP addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    addresses List<String>
    The IP addresses.
    digest String
    The SHA1 digest.
    entries List<HostsEntry>
    The host entries (conversion of addresses and hostnames into objects).
    hostnames List<List<String>>
    The hostnames associated with each of the IP addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    addresses string[]
    The IP addresses.
    digest string
    The SHA1 digest.
    entries HostsEntry[]
    The host entries (conversion of addresses and hostnames into objects).
    hostnames string[][]
    The hostnames associated with each of the IP addresses.
    id string
    The provider-assigned unique ID for this managed resource.
    addresses Sequence[str]
    The IP addresses.
    digest str
    The SHA1 digest.
    entries Sequence[HostsEntry]
    The host entries (conversion of addresses and hostnames into objects).
    hostnames Sequence[Sequence[str]]
    The hostnames associated with each of the IP addresses.
    id str
    The provider-assigned unique ID for this managed resource.
    addresses List<String>
    The IP addresses.
    digest String
    The SHA1 digest.
    entries List<Property Map>
    The host entries (conversion of addresses and hostnames into objects).
    hostnames List<List<String>>
    The hostnames associated with each of the IP addresses.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Hosts Resource

    Get an existing Hosts 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?: HostsState, opts?: CustomResourceOptions): Hosts
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[str]] = None,
        digest: Optional[str] = None,
        entries: Optional[Sequence[HostsEntryArgs]] = None,
        entry: Optional[Sequence[HostsEntryArgs]] = None,
        hostnames: Optional[Sequence[Sequence[str]]] = None,
        node_name: Optional[str] = None) -> Hosts
    func GetHosts(ctx *Context, name string, id IDInput, state *HostsState, opts ...ResourceOption) (*Hosts, error)
    public static Hosts Get(string name, Input<string> id, HostsState? state, CustomResourceOptions? opts = null)
    public static Hosts get(String name, Output<String> id, HostsState 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:
    Addresses List<string>
    The IP addresses.
    Digest string
    The SHA1 digest.
    Entries List<Pulumi.ProxmoxVE.Inputs.HostsEntry>
    The host entries (conversion of addresses and hostnames into objects).
    Entry List<Pulumi.ProxmoxVE.Inputs.HostsEntry>
    A host entry (multiple blocks supported).
    Hostnames List<ImmutableArray<string>>
    The hostnames associated with each of the IP addresses.
    NodeName string
    A node name.
    Addresses []string
    The IP addresses.
    Digest string
    The SHA1 digest.
    Entries []HostsEntryArgs
    The host entries (conversion of addresses and hostnames into objects).
    Entry []HostsEntryArgs
    A host entry (multiple blocks supported).
    Hostnames [][]string
    The hostnames associated with each of the IP addresses.
    NodeName string
    A node name.
    addresses List<String>
    The IP addresses.
    digest String
    The SHA1 digest.
    entries List<HostsEntry>
    The host entries (conversion of addresses and hostnames into objects).
    entry List<HostsEntry>
    A host entry (multiple blocks supported).
    hostnames List<List<String>>
    The hostnames associated with each of the IP addresses.
    nodeName String
    A node name.
    addresses string[]
    The IP addresses.
    digest string
    The SHA1 digest.
    entries HostsEntry[]
    The host entries (conversion of addresses and hostnames into objects).
    entry HostsEntry[]
    A host entry (multiple blocks supported).
    hostnames string[][]
    The hostnames associated with each of the IP addresses.
    nodeName string
    A node name.
    addresses Sequence[str]
    The IP addresses.
    digest str
    The SHA1 digest.
    entries Sequence[HostsEntryArgs]
    The host entries (conversion of addresses and hostnames into objects).
    entry Sequence[HostsEntryArgs]
    A host entry (multiple blocks supported).
    hostnames Sequence[Sequence[str]]
    The hostnames associated with each of the IP addresses.
    node_name str
    A node name.
    addresses List<String>
    The IP addresses.
    digest String
    The SHA1 digest.
    entries List<Property Map>
    The host entries (conversion of addresses and hostnames into objects).
    entry List<Property Map>
    A host entry (multiple blocks supported).
    hostnames List<List<String>>
    The hostnames associated with each of the IP addresses.
    nodeName String
    A node name.

    Supporting Types

    HostsEntry, HostsEntryArgs

    Address string
    The IP address.
    Hostnames List<string>
    The hostnames.
    Address string
    The IP address.
    Hostnames []string
    The hostnames.
    address String
    The IP address.
    hostnames List<String>
    The hostnames.
    address string
    The IP address.
    hostnames string[]
    The hostnames.
    address str
    The IP address.
    hostnames Sequence[str]
    The hostnames.
    address String
    The IP address.
    hostnames List<String>
    The hostnames.

    Import

    ant Notes

    Be careful not to use this resource multiple times for the same 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.10.1 published on Friday, Jun 28, 2024 by Daniel Muehlbachler-Pietrzykowski
    muhlba91/pulumi-proxmoxve