1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. getFile
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves information about an existing file in a Proxmox Virtual Environment node.

    Using getFile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFile(args: GetFileArgs, opts?: InvokeOptions): Promise<GetFileResult>
    function getFileOutput(args: GetFileOutputArgs, opts?: InvokeOptions): Output<GetFileResult>
    def get_file(content_type: Optional[str] = None,
                 datastore_id: Optional[str] = None,
                 file_name: Optional[str] = None,
                 node_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFileResult
    def get_file_output(content_type: Optional[pulumi.Input[str]] = None,
                 datastore_id: Optional[pulumi.Input[str]] = None,
                 file_name: Optional[pulumi.Input[str]] = None,
                 node_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFileResult]
    func GetFile(ctx *Context, args *GetFileArgs, opts ...InvokeOption) (*GetFileResult, error)
    func GetFileOutput(ctx *Context, args *GetFileOutputArgs, opts ...InvokeOption) GetFileResultOutput

    > Note: This function is named GetFile in the Go SDK.

    public static class GetFile 
    {
        public static Task<GetFileResult> InvokeAsync(GetFileArgs args, InvokeOptions? opts = null)
        public static Output<GetFileResult> Invoke(GetFileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFileResult> getFile(GetFileArgs args, InvokeOptions options)
    public static Output<GetFileResult> getFile(GetFileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:index/getFile:getFile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ContentType string
    The content type of the file.
    DatastoreId string
    The identifier of the datastore.
    FileName string
    The name of the file.
    NodeName string
    The name of the node.
    ContentType string
    The content type of the file.
    DatastoreId string
    The identifier of the datastore.
    FileName string
    The name of the file.
    NodeName string
    The name of the node.
    contentType String
    The content type of the file.
    datastoreId String
    The identifier of the datastore.
    fileName String
    The name of the file.
    nodeName String
    The name of the node.
    contentType string
    The content type of the file.
    datastoreId string
    The identifier of the datastore.
    fileName string
    The name of the file.
    nodeName string
    The name of the node.
    content_type str
    The content type of the file.
    datastore_id str
    The identifier of the datastore.
    file_name str
    The name of the file.
    node_name str
    The name of the node.
    contentType String
    The content type of the file.
    datastoreId String
    The identifier of the datastore.
    fileName String
    The name of the file.
    nodeName String
    The name of the node.

    getFile Result

    The following output properties are available:

    ContentType string
    The content type of the file.
    DatastoreId string
    The identifier of the datastore.
    FileFormat string
    The format of the file.
    FileName string
    The name of the file.
    FileSize int
    The size of the file in bytes.
    Id string
    The unique identifier of the file (volume ID).
    NodeName string
    The name of the node.
    Vmid int
    The VM ID associated with the file (if applicable).
    ContentType string
    The content type of the file.
    DatastoreId string
    The identifier of the datastore.
    FileFormat string
    The format of the file.
    FileName string
    The name of the file.
    FileSize int
    The size of the file in bytes.
    Id string
    The unique identifier of the file (volume ID).
    NodeName string
    The name of the node.
    Vmid int
    The VM ID associated with the file (if applicable).
    contentType String
    The content type of the file.
    datastoreId String
    The identifier of the datastore.
    fileFormat String
    The format of the file.
    fileName String
    The name of the file.
    fileSize Integer
    The size of the file in bytes.
    id String
    The unique identifier of the file (volume ID).
    nodeName String
    The name of the node.
    vmid Integer
    The VM ID associated with the file (if applicable).
    contentType string
    The content type of the file.
    datastoreId string
    The identifier of the datastore.
    fileFormat string
    The format of the file.
    fileName string
    The name of the file.
    fileSize number
    The size of the file in bytes.
    id string
    The unique identifier of the file (volume ID).
    nodeName string
    The name of the node.
    vmid number
    The VM ID associated with the file (if applicable).
    content_type str
    The content type of the file.
    datastore_id str
    The identifier of the datastore.
    file_format str
    The format of the file.
    file_name str
    The name of the file.
    file_size int
    The size of the file in bytes.
    id str
    The unique identifier of the file (volume ID).
    node_name str
    The name of the node.
    vmid int
    The VM ID associated with the file (if applicable).
    contentType String
    The content type of the file.
    datastoreId String
    The identifier of the datastore.
    fileFormat String
    The format of the file.
    fileName String
    The name of the file.
    fileSize Number
    The size of the file in bytes.
    id String
    The unique identifier of the file (volume ID).
    nodeName String
    The name of the node.
    vmid Number
    The VM ID associated with the file (if applicable).

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
    published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.