1. Packages
  2. OVH
  3. API Docs
  4. Me
  5. getInstallationTemplate
OVHCloud v0.37.0 published on Wednesday, Feb 21, 2024 by OVHcloud

ovh.Me.getInstallationTemplate

Explore with Pulumi AI

ovh logo
OVHCloud v0.37.0 published on Wednesday, Feb 21, 2024 by OVHcloud

    Use this data source to get a custom installation template available for dedicated servers.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var mytemplate = Ovh.Me.GetInstallationTemplate.Invoke(new()
        {
            TemplateName = "mytemplate",
        });
    
    });
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Me"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Me.GetInstallationTemplate(ctx, &me.GetInstallationTemplateArgs{
    			TemplateName: "mytemplate",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.Me.MeFunctions;
    import com.pulumi.ovh.Me.inputs.GetInstallationTemplateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var mytemplate = MeFunctions.getInstallationTemplate(GetInstallationTemplateArgs.builder()
                .templateName("mytemplate")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_ovh as ovh
    
    mytemplate = ovh.Me.get_installation_template(template_name="mytemplate")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@pulumi/ovh";
    
    const mytemplate = ovh.Me.getInstallationTemplate({
        templateName: "mytemplate",
    });
    
    variables:
      mytemplate:
        fn::invoke:
          Function: ovh:Me:getInstallationTemplate
          Arguments:
            templateName: mytemplate
    

    Using getInstallationTemplate

    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 getInstallationTemplate(args: GetInstallationTemplateArgs, opts?: InvokeOptions): Promise<GetInstallationTemplateResult>
    function getInstallationTemplateOutput(args: GetInstallationTemplateOutputArgs, opts?: InvokeOptions): Output<GetInstallationTemplateResult>
    def get_installation_template(template_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetInstallationTemplateResult
    def get_installation_template_output(template_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetInstallationTemplateResult]
    func GetInstallationTemplate(ctx *Context, args *GetInstallationTemplateArgs, opts ...InvokeOption) (*GetInstallationTemplateResult, error)
    func GetInstallationTemplateOutput(ctx *Context, args *GetInstallationTemplateOutputArgs, opts ...InvokeOption) GetInstallationTemplateResultOutput

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

    public static class GetInstallationTemplate 
    {
        public static Task<GetInstallationTemplateResult> InvokeAsync(GetInstallationTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetInstallationTemplateResult> Invoke(GetInstallationTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstallationTemplateResult> getInstallationTemplate(GetInstallationTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: ovh:Me/getInstallationTemplate:getInstallationTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TemplateName string
    This template name
    TemplateName string
    This template name
    templateName String
    This template name
    templateName string
    This template name
    template_name str
    This template name
    templateName String
    This template name

    getInstallationTemplate Result

    The following output properties are available:

    AvailableLanguages List<string>
    List of all language available for this template.
    Beta bool
    This distribution is new and, although tested and functional, may still display odd behaviour.
    BitFormat int
    This template bit format (32 or 64).
    Category string
    Category of this template (informative only). (basic, customer, hosting, other, readyToUse, virtualisation).
    Customizations List<GetInstallationTemplateCustomization>
    DefaultLanguage string
    The default language of this template.
    Deprecated bool
    is this distribution deprecated.
    Description string
    information about this template.
    Distribution string
    the distribution this template is based on.
    Family string
    this template family type (bsd,linux,solaris,windows).
    Filesystems List<string>
    Filesystems available (btrfs,ext3,ext4,ntfs,reiserfs,swap,ufs,xfs,zfs).
    HardRaidConfiguration bool
    This distribution supports hardware raid configuration through the OVHcloud API.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModification string
    Date of last modification of the base image.
    LvmReady bool
    PartitionSchemes List<GetInstallationTemplatePartitionScheme>
    SupportsDistributionKernel bool
    This distribution supports installation using the distribution's native kernel instead of the recommended OVHcloud kernel.
    SupportsRtm bool
    This distribution supports RTM software.
    SupportsSqlServer bool
    This distribution supports the microsoft SQL server.
    TemplateName string
    AvailableLanguages []string
    List of all language available for this template.
    Beta bool
    This distribution is new and, although tested and functional, may still display odd behaviour.
    BitFormat int
    This template bit format (32 or 64).
    Category string
    Category of this template (informative only). (basic, customer, hosting, other, readyToUse, virtualisation).
    Customizations []GetInstallationTemplateCustomization
    DefaultLanguage string
    The default language of this template.
    Deprecated bool
    is this distribution deprecated.
    Description string
    information about this template.
    Distribution string
    the distribution this template is based on.
    Family string
    this template family type (bsd,linux,solaris,windows).
    Filesystems []string
    Filesystems available (btrfs,ext3,ext4,ntfs,reiserfs,swap,ufs,xfs,zfs).
    HardRaidConfiguration bool
    This distribution supports hardware raid configuration through the OVHcloud API.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModification string
    Date of last modification of the base image.
    LvmReady bool
    PartitionSchemes []GetInstallationTemplatePartitionSchemeType
    SupportsDistributionKernel bool
    This distribution supports installation using the distribution's native kernel instead of the recommended OVHcloud kernel.
    SupportsRtm bool
    This distribution supports RTM software.
    SupportsSqlServer bool
    This distribution supports the microsoft SQL server.
    TemplateName string
    availableLanguages List<String>
    List of all language available for this template.
    beta Boolean
    This distribution is new and, although tested and functional, may still display odd behaviour.
    bitFormat Integer
    This template bit format (32 or 64).
    category String
    Category of this template (informative only). (basic, customer, hosting, other, readyToUse, virtualisation).
    customizations List<GetInstallationTemplateCustomization>
    defaultLanguage String
    The default language of this template.
    deprecated Boolean
    is this distribution deprecated.
    description String
    information about this template.
    distribution String
    the distribution this template is based on.
    family String
    this template family type (bsd,linux,solaris,windows).
    filesystems List<String>
    Filesystems available (btrfs,ext3,ext4,ntfs,reiserfs,swap,ufs,xfs,zfs).
    hardRaidConfiguration Boolean
    This distribution supports hardware raid configuration through the OVHcloud API.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModification String
    Date of last modification of the base image.
    lvmReady Boolean
    partitionSchemes List<GetInstallationTemplatePartitionScheme>
    supportsDistributionKernel Boolean
    This distribution supports installation using the distribution's native kernel instead of the recommended OVHcloud kernel.
    supportsRtm Boolean
    This distribution supports RTM software.
    supportsSqlServer Boolean
    This distribution supports the microsoft SQL server.
    templateName String
    availableLanguages string[]
    List of all language available for this template.
    beta boolean
    This distribution is new and, although tested and functional, may still display odd behaviour.
    bitFormat number
    This template bit format (32 or 64).
    category string
    Category of this template (informative only). (basic, customer, hosting, other, readyToUse, virtualisation).
    customizations GetInstallationTemplateCustomization[]
    defaultLanguage string
    The default language of this template.
    deprecated boolean
    is this distribution deprecated.
    description string
    information about this template.
    distribution string
    the distribution this template is based on.
    family string
    this template family type (bsd,linux,solaris,windows).
    filesystems string[]
    Filesystems available (btrfs,ext3,ext4,ntfs,reiserfs,swap,ufs,xfs,zfs).
    hardRaidConfiguration boolean
    This distribution supports hardware raid configuration through the OVHcloud API.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModification string
    Date of last modification of the base image.
    lvmReady boolean
    partitionSchemes GetInstallationTemplatePartitionScheme[]
    supportsDistributionKernel boolean
    This distribution supports installation using the distribution's native kernel instead of the recommended OVHcloud kernel.
    supportsRtm boolean
    This distribution supports RTM software.
    supportsSqlServer boolean
    This distribution supports the microsoft SQL server.
    templateName string
    available_languages Sequence[str]
    List of all language available for this template.
    beta bool
    This distribution is new and, although tested and functional, may still display odd behaviour.
    bit_format int
    This template bit format (32 or 64).
    category str
    Category of this template (informative only). (basic, customer, hosting, other, readyToUse, virtualisation).
    customizations GetInstallationTemplateCustomization]
    default_language str
    The default language of this template.
    deprecated bool
    is this distribution deprecated.
    description str
    information about this template.
    distribution str
    the distribution this template is based on.
    family str
    this template family type (bsd,linux,solaris,windows).
    filesystems Sequence[str]
    Filesystems available (btrfs,ext3,ext4,ntfs,reiserfs,swap,ufs,xfs,zfs).
    hard_raid_configuration bool
    This distribution supports hardware raid configuration through the OVHcloud API.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modification str
    Date of last modification of the base image.
    lvm_ready bool
    partition_schemes GetInstallationTemplatePartitionScheme]
    supports_distribution_kernel bool
    This distribution supports installation using the distribution's native kernel instead of the recommended OVHcloud kernel.
    supports_rtm bool
    This distribution supports RTM software.
    supports_sql_server bool
    This distribution supports the microsoft SQL server.
    template_name str
    availableLanguages List<String>
    List of all language available for this template.
    beta Boolean
    This distribution is new and, although tested and functional, may still display odd behaviour.
    bitFormat Number
    This template bit format (32 or 64).
    category String
    Category of this template (informative only). (basic, customer, hosting, other, readyToUse, virtualisation).
    customizations List<Property Map>
    defaultLanguage String
    The default language of this template.
    deprecated Boolean
    is this distribution deprecated.
    description String
    information about this template.
    distribution String
    the distribution this template is based on.
    family String
    this template family type (bsd,linux,solaris,windows).
    filesystems List<String>
    Filesystems available (btrfs,ext3,ext4,ntfs,reiserfs,swap,ufs,xfs,zfs).
    hardRaidConfiguration Boolean
    This distribution supports hardware raid configuration through the OVHcloud API.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModification String
    Date of last modification of the base image.
    lvmReady Boolean
    partitionSchemes List<Property Map>
    supportsDistributionKernel Boolean
    This distribution supports installation using the distribution's native kernel instead of the recommended OVHcloud kernel.
    supportsRtm Boolean
    This distribution supports RTM software.
    supportsSqlServer Boolean
    This distribution supports the microsoft SQL server.
    templateName String

    Supporting Types

    GetInstallationTemplateCustomization

    ChangeLog string
    (DEPRECATED) Template change log details.

    Deprecated:field is not used anymore

    CustomHostname string
    Set up the server using the provided hostname instead of the default hostname.
    PostInstallationScriptLink string
    Indicate the URL where your postinstall customisation script is located.
    PostInstallationScriptReturn string
    indicate the string returned by your postinstall customisation script on successful execution. Advice: your script should return a unique validation string in case of succes. A good example is 'loh1Xee7eo OK OK OK UGh8Ang1Gu'.
    Rating int
    (DEPRECATED) Rating.

    Deprecated:field is not used anymore

    SshKeyName string
    Name of the ssh key that should be installed. Password login will be disabled.
    UseDistributionKernel bool
    Use the distribution's native kernel instead of the recommended OVHcloud Kernel.
    ChangeLog string
    (DEPRECATED) Template change log details.

    Deprecated:field is not used anymore

    CustomHostname string
    Set up the server using the provided hostname instead of the default hostname.
    PostInstallationScriptLink string
    Indicate the URL where your postinstall customisation script is located.
    PostInstallationScriptReturn string
    indicate the string returned by your postinstall customisation script on successful execution. Advice: your script should return a unique validation string in case of succes. A good example is 'loh1Xee7eo OK OK OK UGh8Ang1Gu'.
    Rating int
    (DEPRECATED) Rating.

    Deprecated:field is not used anymore

    SshKeyName string
    Name of the ssh key that should be installed. Password login will be disabled.
    UseDistributionKernel bool
    Use the distribution's native kernel instead of the recommended OVHcloud Kernel.
    changeLog String
    (DEPRECATED) Template change log details.

    Deprecated:field is not used anymore

    customHostname String
    Set up the server using the provided hostname instead of the default hostname.
    postInstallationScriptLink String
    Indicate the URL where your postinstall customisation script is located.
    postInstallationScriptReturn String
    indicate the string returned by your postinstall customisation script on successful execution. Advice: your script should return a unique validation string in case of succes. A good example is 'loh1Xee7eo OK OK OK UGh8Ang1Gu'.
    rating Integer
    (DEPRECATED) Rating.

    Deprecated:field is not used anymore

    sshKeyName String
    Name of the ssh key that should be installed. Password login will be disabled.
    useDistributionKernel Boolean
    Use the distribution's native kernel instead of the recommended OVHcloud Kernel.
    changeLog string
    (DEPRECATED) Template change log details.

    Deprecated:field is not used anymore

    customHostname string
    Set up the server using the provided hostname instead of the default hostname.
    postInstallationScriptLink string
    Indicate the URL where your postinstall customisation script is located.
    postInstallationScriptReturn string
    indicate the string returned by your postinstall customisation script on successful execution. Advice: your script should return a unique validation string in case of succes. A good example is 'loh1Xee7eo OK OK OK UGh8Ang1Gu'.
    rating number
    (DEPRECATED) Rating.

    Deprecated:field is not used anymore

    sshKeyName string
    Name of the ssh key that should be installed. Password login will be disabled.
    useDistributionKernel boolean
    Use the distribution's native kernel instead of the recommended OVHcloud Kernel.
    change_log str
    (DEPRECATED) Template change log details.

    Deprecated:field is not used anymore

    custom_hostname str
    Set up the server using the provided hostname instead of the default hostname.
    post_installation_script_link str
    Indicate the URL where your postinstall customisation script is located.
    post_installation_script_return str
    indicate the string returned by your postinstall customisation script on successful execution. Advice: your script should return a unique validation string in case of succes. A good example is 'loh1Xee7eo OK OK OK UGh8Ang1Gu'.
    rating int
    (DEPRECATED) Rating.

    Deprecated:field is not used anymore

    ssh_key_name str
    Name of the ssh key that should be installed. Password login will be disabled.
    use_distribution_kernel bool
    Use the distribution's native kernel instead of the recommended OVHcloud Kernel.
    changeLog String
    (DEPRECATED) Template change log details.

    Deprecated:field is not used anymore

    customHostname String
    Set up the server using the provided hostname instead of the default hostname.
    postInstallationScriptLink String
    Indicate the URL where your postinstall customisation script is located.
    postInstallationScriptReturn String
    indicate the string returned by your postinstall customisation script on successful execution. Advice: your script should return a unique validation string in case of succes. A good example is 'loh1Xee7eo OK OK OK UGh8Ang1Gu'.
    rating Number
    (DEPRECATED) Rating.

    Deprecated:field is not used anymore

    sshKeyName String
    Name of the ssh key that should be installed. Password login will be disabled.
    useDistributionKernel Boolean
    Use the distribution's native kernel instead of the recommended OVHcloud Kernel.

    GetInstallationTemplatePartitionScheme

    HardwareRaids List<GetInstallationTemplatePartitionSchemeHardwareRaid>
    Name string
    Hardware RAID name.
    Partitions List<GetInstallationTemplatePartitionSchemePartition>
    Priority int
    on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications).
    HardwareRaids []GetInstallationTemplatePartitionSchemeHardwareRaidType
    Name string
    Hardware RAID name.
    Partitions []GetInstallationTemplatePartitionSchemePartitionType
    Priority int
    on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications).
    hardwareRaids List<GetInstallationTemplatePartitionSchemeHardwareRaid>
    name String
    Hardware RAID name.
    partitions List<GetInstallationTemplatePartitionSchemePartition>
    priority Integer
    on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications).
    hardwareRaids GetInstallationTemplatePartitionSchemeHardwareRaid[]
    name string
    Hardware RAID name.
    partitions GetInstallationTemplatePartitionSchemePartition[]
    priority number
    on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications).
    hardware_raids GetInstallationTemplatePartitionSchemeHardwareRaid]
    name str
    Hardware RAID name.
    partitions GetInstallationTemplatePartitionSchemePartition]
    priority int
    on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications).
    hardwareRaids List<Property Map>
    name String
    Hardware RAID name.
    partitions List<Property Map>
    priority Number
    on a reinstall, if a partitioning scheme is not specified, the one with the higher priority will be used by default, among all the compatible partitioning schemes (given the underlying hardware specifications).

    GetInstallationTemplatePartitionSchemeHardwareRaid

    Disks List<string>
    Disk List. Syntax is cX:dY for disks and [cX:dY,cX:dY] for groups. With X and Y resp. the controller id and the disk id.
    Mode string
    RAID mode (raid0, raid1, raid10, raid5, raid50, raid6, raid60).
    Name string
    Hardware RAID name.
    Step int
    Specifies the creation order of the hardware RAID.
    Disks []string
    Disk List. Syntax is cX:dY for disks and [cX:dY,cX:dY] for groups. With X and Y resp. the controller id and the disk id.
    Mode string
    RAID mode (raid0, raid1, raid10, raid5, raid50, raid6, raid60).
    Name string
    Hardware RAID name.
    Step int
    Specifies the creation order of the hardware RAID.
    disks List<String>
    Disk List. Syntax is cX:dY for disks and [cX:dY,cX:dY] for groups. With X and Y resp. the controller id and the disk id.
    mode String
    RAID mode (raid0, raid1, raid10, raid5, raid50, raid6, raid60).
    name String
    Hardware RAID name.
    step Integer
    Specifies the creation order of the hardware RAID.
    disks string[]
    Disk List. Syntax is cX:dY for disks and [cX:dY,cX:dY] for groups. With X and Y resp. the controller id and the disk id.
    mode string
    RAID mode (raid0, raid1, raid10, raid5, raid50, raid6, raid60).
    name string
    Hardware RAID name.
    step number
    Specifies the creation order of the hardware RAID.
    disks Sequence[str]
    Disk List. Syntax is cX:dY for disks and [cX:dY,cX:dY] for groups. With X and Y resp. the controller id and the disk id.
    mode str
    RAID mode (raid0, raid1, raid10, raid5, raid50, raid6, raid60).
    name str
    Hardware RAID name.
    step int
    Specifies the creation order of the hardware RAID.
    disks List<String>
    Disk List. Syntax is cX:dY for disks and [cX:dY,cX:dY] for groups. With X and Y resp. the controller id and the disk id.
    mode String
    RAID mode (raid0, raid1, raid10, raid5, raid50, raid6, raid60).
    name String
    Hardware RAID name.
    step Number
    Specifies the creation order of the hardware RAID.

    GetInstallationTemplatePartitionSchemePartition

    Filesystem string
    Partition filesystem.
    Mountpoint string
    partition mount point.
    Order int
    step or order. specifies the creation order of the partition on the disk
    Raid string
    raid partition type.
    Size int
    size of partition in MB, 0 => rest of the space.
    Type string
    partition type.
    VolumeName string
    The volume name needed for proxmox distribution
    Filesystem string
    Partition filesystem.
    Mountpoint string
    partition mount point.
    Order int
    step or order. specifies the creation order of the partition on the disk
    Raid string
    raid partition type.
    Size int
    size of partition in MB, 0 => rest of the space.
    Type string
    partition type.
    VolumeName string
    The volume name needed for proxmox distribution
    filesystem String
    Partition filesystem.
    mountpoint String
    partition mount point.
    order Integer
    step or order. specifies the creation order of the partition on the disk
    raid String
    raid partition type.
    size Integer
    size of partition in MB, 0 => rest of the space.
    type String
    partition type.
    volumeName String
    The volume name needed for proxmox distribution
    filesystem string
    Partition filesystem.
    mountpoint string
    partition mount point.
    order number
    step or order. specifies the creation order of the partition on the disk
    raid string
    raid partition type.
    size number
    size of partition in MB, 0 => rest of the space.
    type string
    partition type.
    volumeName string
    The volume name needed for proxmox distribution
    filesystem str
    Partition filesystem.
    mountpoint str
    partition mount point.
    order int
    step or order. specifies the creation order of the partition on the disk
    raid str
    raid partition type.
    size int
    size of partition in MB, 0 => rest of the space.
    type str
    partition type.
    volume_name str
    The volume name needed for proxmox distribution
    filesystem String
    Partition filesystem.
    mountpoint String
    partition mount point.
    order Number
    step or order. specifies the creation order of the partition on the disk
    raid String
    raid partition type.
    size Number
    size of partition in MB, 0 => rest of the space.
    type String
    partition type.
    volumeName String
    The volume name needed for proxmox distribution

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v0.37.0 published on Wednesday, Feb 21, 2024 by OVHcloud