1. Packages
  2. Xen Orchestra
  3. API Docs
  4. Vdi
xenorchestra v1.5.0 published on Friday, Mar 7, 2025 by Vates

xenorchestra.Vdi

Explore with Pulumi AI

xenorchestra logo
xenorchestra v1.5.0 published on Friday, Mar 7, 2025 by Vates

    Creates a Xen Orchestra vdi resource.

    Create Vdi Resource

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

    Constructor syntax

    new Vdi(name: string, args: VdiArgs, opts?: CustomResourceOptions);
    @overload
    def Vdi(resource_name: str,
            args: VdiArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Vdi(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            filepath: Optional[str] = None,
            name_label: Optional[str] = None,
            sr_id: Optional[str] = None,
            type: Optional[str] = None)
    func NewVdi(ctx *Context, name string, args VdiArgs, opts ...ResourceOption) (*Vdi, error)
    public Vdi(string name, VdiArgs args, CustomResourceOptions? opts = null)
    public Vdi(String name, VdiArgs args)
    public Vdi(String name, VdiArgs args, CustomResourceOptions options)
    
    type: xenorchestra:Vdi
    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 VdiArgs
    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 VdiArgs
    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 VdiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VdiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VdiArgs
    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 vdiResource = new Xenorchestra.Vdi("vdiResource", new()
    {
        Filepath = "string",
        NameLabel = "string",
        SrId = "string",
        Type = "string",
    });
    
    example, err := xenorchestra.NewVdi(ctx, "vdiResource", &xenorchestra.VdiArgs{
    	Filepath:  pulumi.String("string"),
    	NameLabel: pulumi.String("string"),
    	SrId:      pulumi.String("string"),
    	Type:      pulumi.String("string"),
    })
    
    var vdiResource = new Vdi("vdiResource", VdiArgs.builder()
        .filepath("string")
        .nameLabel("string")
        .srId("string")
        .type("string")
        .build());
    
    vdi_resource = xenorchestra.Vdi("vdiResource",
        filepath="string",
        name_label="string",
        sr_id="string",
        type="string")
    
    const vdiResource = new xenorchestra.Vdi("vdiResource", {
        filepath: "string",
        nameLabel: "string",
        srId: "string",
        type: "string",
    });
    
    type: xenorchestra:Vdi
    properties:
        filepath: string
        nameLabel: string
        srId: string
        type: string
    

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

    Filepath string
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    NameLabel string
    The name label of the VDI
    SrId string
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    Type string
    Only raw uploads are supported today, but vhd support may be added in the future.
    Filepath string
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    NameLabel string
    The name label of the VDI
    SrId string
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    Type string
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath String
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    nameLabel String
    The name label of the VDI
    srId String
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type String
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath string
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    nameLabel string
    The name label of the VDI
    srId string
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type string
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath str
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    name_label str
    The name label of the VDI
    sr_id str
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type str
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath String
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    nameLabel String
    The name label of the VDI
    srId String
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type String
    Only raw uploads are supported today, but vhd support may be added in the future.

    Outputs

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

    Get an existing Vdi 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?: VdiState, opts?: CustomResourceOptions): Vdi
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            filepath: Optional[str] = None,
            name_label: Optional[str] = None,
            sr_id: Optional[str] = None,
            type: Optional[str] = None) -> Vdi
    func GetVdi(ctx *Context, name string, id IDInput, state *VdiState, opts ...ResourceOption) (*Vdi, error)
    public static Vdi Get(string name, Input<string> id, VdiState? state, CustomResourceOptions? opts = null)
    public static Vdi get(String name, Output<String> id, VdiState state, CustomResourceOptions options)
    resources:  _:    type: xenorchestra:Vdi    get:      id: ${id}
    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:
    Filepath string
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    NameLabel string
    The name label of the VDI
    SrId string
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    Type string
    Only raw uploads are supported today, but vhd support may be added in the future.
    Filepath string
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    NameLabel string
    The name label of the VDI
    SrId string
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    Type string
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath String
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    nameLabel String
    The name label of the VDI
    srId String
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type String
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath string
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    nameLabel string
    The name label of the VDI
    srId string
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type string
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath str
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    name_label str
    The name label of the VDI
    sr_id str
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type str
    Only raw uploads are supported today, but vhd support may be added in the future.
    filepath String
    The file path to the ISO or vdi image that should be uploaded when the VDI is created.
    nameLabel String
    The name label of the VDI
    srId String
    The id of the storage repository the VDI should be created in. Make sure the storage repository supports the file you are uploading! For example, ISOs should only be uploaded to ISO storage repositories.
    type String
    Only raw uploads are supported today, but vhd support may be added in the future.

    Package Details

    Repository
    xenorchestra vatesfr/pulumi-xenorchestra
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the xenorchestra Terraform Provider.
    xenorchestra logo
    xenorchestra v1.5.0 published on Friday, Mar 7, 2025 by Vates