Docs Packages
  1. Packages
  2. vSphere
  3. API Docs
  4. VappEntity
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.VappEntity

Explore with Pulumi AI

vsphere logo
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

    Create VappEntity Resource

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

    Constructor syntax

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

@overload
def VappEntity(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               container_id: Optional[str] = None,
               target_id: Optional[str] = None,
               custom_attributes: Optional[Mapping[str, str]] = None,
               start_action: Optional[str] = None,
               start_delay: Optional[int] = None,
               start_order: Optional[int] = None,
               stop_action: Optional[str] = None,
               stop_delay: Optional[int] = None,
               tags: Optional[Sequence[str]] = None,
               wait_for_guest: Optional[bool] = None)
    func NewVappEntity(ctx *Context, name string, args VappEntityArgs, opts ...ResourceOption) (*VappEntity, error)
    public VappEntity(string name, VappEntityArgs args, CustomResourceOptions? opts = null)
    public VappEntity(String name, VappEntityArgs args)
public VappEntity(String name, VappEntityArgs args, CustomResourceOptions options)

    type: vsphere:VappEntity
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 VappEntityArgs
    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 VappEntityArgs
    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 VappEntityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VappEntityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VappEntityArgs
    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 vappEntityResource = new VSphere.VappEntity("vappEntityResource", new()
{
    ContainerId = "string",
    TargetId = "string",
    CustomAttributes = 
    {
        { "string", "string" },
    },
    StartAction = "string",
    StartDelay = 0,
    StartOrder = 0,
    StopAction = "string",
    StopDelay = 0,
    Tags = new[]
    {
        "string",
    },
    WaitForGuest = false,
});

    example, err := vsphere.NewVappEntity(ctx, "vappEntityResource", &vsphere.VappEntityArgs{
	ContainerId: pulumi.String("string"),
	TargetId:    pulumi.String("string"),
	CustomAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	StartAction: pulumi.String("string"),
	StartDelay:  pulumi.Int(0),
	StartOrder:  pulumi.Int(0),
	StopAction:  pulumi.String("string"),
	StopDelay:   pulumi.Int(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	WaitForGuest: pulumi.Bool(false),
})

    var vappEntityResource = new VappEntity("vappEntityResource", VappEntityArgs.builder()
    .containerId("string")
    .targetId("string")
    .customAttributes(Map.of("string", "string"))
    .startAction("string")
    .startDelay(0)
    .startOrder(0)
    .stopAction("string")
    .stopDelay(0)
    .tags("string")
    .waitForGuest(false)
    .build());

    vapp_entity_resource = vsphere.VappEntity("vappEntityResource",
    container_id="string",
    target_id="string",
    custom_attributes={
        "string": "string",
    },
    start_action="string",
    start_delay=0,
    start_order=0,
    stop_action="string",
    stop_delay=0,
    tags=["string"],
    wait_for_guest=False)

    const vappEntityResource = new vsphere.VappEntity("vappEntityResource", {
    containerId: "string",
    targetId: "string",
    customAttributes: {
        string: "string",
    },
    startAction: "string",
    startDelay: 0,
    startOrder: 0,
    stopAction: "string",
    stopDelay: 0,
    tags: ["string"],
    waitForGuest: false,
});

    type: vsphere:VappEntity
properties:
    containerId: string
    customAttributes:
        string: string
    startAction: string
    startDelay: 0
    startOrder: 0
    stopAction: string
    stopDelay: 0
    tags:
        - string
    targetId: string
    waitForGuest: false

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

    ContainerId string
    Managed object ID of the vApp container the entity is a member of.
    TargetId string
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    CustomAttributes Dictionary<string, string>
    A list of custom attributes to set on this resource.
    StartAction string
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    StartDelay int
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    StartOrder int
    Order to start and stop target in vApp. Default: 1
    StopAction string
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    StopDelay int
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    Tags List<string>
    A list of tag IDs to apply to this object.
    WaitForGuest bool
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    ContainerId string
    Managed object ID of the vApp container the entity is a member of.
    TargetId string
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    CustomAttributes map[string]string
    A list of custom attributes to set on this resource.
    StartAction string
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    StartDelay int
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    StartOrder int
    Order to start and stop target in vApp. Default: 1
    StopAction string
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    StopDelay int
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    Tags []string
    A list of tag IDs to apply to this object.
    WaitForGuest bool
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    containerId String
    Managed object ID of the vApp container the entity is a member of.
    targetId String
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    customAttributes Map<String,String>
    A list of custom attributes to set on this resource.
    startAction String
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    startDelay Integer
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    startOrder Integer
    Order to start and stop target in vApp. Default: 1
    stopAction String
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stopDelay Integer
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags List<String>
    A list of tag IDs to apply to this object.
    waitForGuest Boolean
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    containerId string
    Managed object ID of the vApp container the entity is a member of.
    targetId string
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    customAttributes {[key: string]: string}
    A list of custom attributes to set on this resource.
    startAction string
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    startDelay number
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    startOrder number
    Order to start and stop target in vApp. Default: 1
    stopAction string
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stopDelay number
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags string[]
    A list of tag IDs to apply to this object.
    waitForGuest boolean
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    container_id str
    Managed object ID of the vApp container the entity is a member of.
    target_id str
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    custom_attributes Mapping[str, str]
    A list of custom attributes to set on this resource.
    start_action str
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    start_delay int
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    start_order int
    Order to start and stop target in vApp. Default: 1
    stop_action str
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stop_delay int
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags Sequence[str]
    A list of tag IDs to apply to this object.
    wait_for_guest bool
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    containerId String
    Managed object ID of the vApp container the entity is a member of.
    targetId String
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    customAttributes Map<String>
    A list of custom attributes to set on this resource.
    startAction String
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    startDelay Number
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    startOrder Number
    Order to start and stop target in vApp. Default: 1
    stopAction String
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stopDelay Number
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags List<String>
    A list of tag IDs to apply to this object.
    waitForGuest Boolean
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false

    Outputs

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

    Get an existing VappEntity 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?: VappEntityState, opts?: CustomResourceOptions): VappEntity
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        container_id: Optional[str] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        start_action: Optional[str] = None,
        start_delay: Optional[int] = None,
        start_order: Optional[int] = None,
        stop_action: Optional[str] = None,
        stop_delay: Optional[int] = None,
        tags: Optional[Sequence[str]] = None,
        target_id: Optional[str] = None,
        wait_for_guest: Optional[bool] = None) -> VappEntity
    func GetVappEntity(ctx *Context, name string, id IDInput, state *VappEntityState, opts ...ResourceOption) (*VappEntity, error)
    public static VappEntity Get(string name, Input<string> id, VappEntityState? state, CustomResourceOptions? opts = null)
    public static VappEntity get(String name, Output<String> id, VappEntityState 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:
    ContainerId string
    Managed object ID of the vApp container the entity is a member of.
    CustomAttributes Dictionary<string, string>
    A list of custom attributes to set on this resource.
    StartAction string
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    StartDelay int
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    StartOrder int
    Order to start and stop target in vApp. Default: 1
    StopAction string
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    StopDelay int
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    Tags List<string>
    A list of tag IDs to apply to this object.
    TargetId string
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    WaitForGuest bool
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    ContainerId string
    Managed object ID of the vApp container the entity is a member of.
    CustomAttributes map[string]string
    A list of custom attributes to set on this resource.
    StartAction string
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    StartDelay int
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    StartOrder int
    Order to start and stop target in vApp. Default: 1
    StopAction string
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    StopDelay int
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    Tags []string
    A list of tag IDs to apply to this object.
    TargetId string
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    WaitForGuest bool
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    containerId String
    Managed object ID of the vApp container the entity is a member of.
    customAttributes Map<String,String>
    A list of custom attributes to set on this resource.
    startAction String
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    startDelay Integer
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    startOrder Integer
    Order to start and stop target in vApp. Default: 1
    stopAction String
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stopDelay Integer
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags List<String>
    A list of tag IDs to apply to this object.
    targetId String
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    waitForGuest Boolean
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    containerId string
    Managed object ID of the vApp container the entity is a member of.
    customAttributes {[key: string]: string}
    A list of custom attributes to set on this resource.
    startAction string
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    startDelay number
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    startOrder number
    Order to start and stop target in vApp. Default: 1
    stopAction string
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stopDelay number
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags string[]
    A list of tag IDs to apply to this object.
    targetId string
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    waitForGuest boolean
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    container_id str
    Managed object ID of the vApp container the entity is a member of.
    custom_attributes Mapping[str, str]
    A list of custom attributes to set on this resource.
    start_action str
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    start_delay int
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    start_order int
    Order to start and stop target in vApp. Default: 1
    stop_action str
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stop_delay int
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags Sequence[str]
    A list of tag IDs to apply to this object.
    target_id str
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    wait_for_guest bool
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
    containerId String
    Managed object ID of the vApp container the entity is a member of.
    customAttributes Map<String>
    A list of custom attributes to set on this resource.
    startAction String
    How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
    startDelay Number
    Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
    startOrder Number
    Order to start and stop target in vApp. Default: 1
    stopAction String
    Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
    stopDelay Number
    Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
    tags List<String>
    A list of tag IDs to apply to this object.
    targetId String
    Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.
    waitForGuest Boolean
    Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-vsphere