Skip to content

Latest commit

 

History

History
422 lines (313 loc) · 12.2 KB

Set-IntersightCloudAwsVirtualMachine.md

File metadata and controls

422 lines (313 loc) · 12.2 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightCloudAwsVirtualMachine

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightCloudAwsVirtualMachine [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-BootTime< DateTime>][-Capacity< InfraHardwareInfo>][-CpuUtilization< float>][-GuestInfo< VirtualizationGuestInfo>][-HypervisorType< CloudAwsVirtualMachine.HypervisorTypeEnum>][-Identity< string>][-IpAddress< System.Collections.Generic.List`1[string]>][-MemoryCapacity< VirtualizationMemoryCapacity>][-MemoryUtilization< float>][[-Moid]< string>][-Name< string>][-PowerState< CloudAwsVirtualMachine.PowerStateEnum>][-ProcessorCapacity< VirtualizationComputeCapacity>][-Provider< CloudAwsVirtualMachine.ProviderEnum>][-RegisteredDevice< AssetDeviceRegistrationRelationship>][-State< CloudAwsVirtualMachine.StateEnum>][-Tags< System.Collections.Generic.List`1[MoTag]>][-Uuid< string>][-VmCreationTime< DateTime>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'CloudAwsVirtualMachine' resource.

PARAMETERS

-AdditionalProperties

Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-BootTime

Time when this VM booted up.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Capacity

Provisioned CPU and memory information for this virtual machine.

Note :- Use Initialize-IntersightInfraHardwareInfo to create the object of complex type InfraHardwareInfo

Type: InfraHardwareInfo
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-CpuUtilization

Average CPU utilization percentage derived as a ratio of CPU used to CPU allocated. The value is calculated whenever inventory is performed.

Type: float
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-GuestInfo

Guest operating system details running on this machine.

Note :- Use Initialize-IntersightVirtualizationGuestInfo to create the object of complex type VirtualizationGuestInfo

Type: VirtualizationGuestInfo
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-HypervisorType

Type of hypervisor where the virtual machine is hosted for example ESXi.\n* ESXi - The hypervisor running on the HyperFlex cluster is a Vmware ESXi hypervisor of any version.\n* Hyper-V - The hypervisor running on the HyperFlex cluster is Microsoft Hyper-V.\n* Unknown - The hypervisor running on the HyperFlex cluster is not known.

Type: CloudAwsVirtualMachine.HypervisorTypeEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Identity

The internally generated identity of this VM. This entity is not manipulated by users. It aids in uniquely identifying the virtual machine object. For VMware, this is MOR (managed object reference).

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-IpAddress

Type: System.Collections.Generic.List`1[string]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-MemoryCapacity

The capacity and usage information for memory on this virtual machine.

Note :- Use Initialize-IntersightVirtualizationMemoryCapacity to create the object of complex type VirtualizationMemoryCapacity

Type: VirtualizationMemoryCapacity
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-MemoryUtilization

Average memory utilization percentage derived as a ratio of memory used to available memory. The value is calculated whenever inventory is performed.

Type: float
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Moid

The unique identifier of this Managed Object instance.

Type: string
Parameter Sets: (All)
Aliases:

Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Name

User-provided name to identify the virtual machine.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-PowerState

Power state of the virtual machine.\n* Unknown - The entity's power state is unknown.\n* PoweringOn - The entity is powering on.\n* PoweredOn - The entity is powered on.\n* PoweringOff - The entity is powering off.\n* PoweredOff - The entity is powered down.\n* StandBy - The entity is in standby mode.\n* Paused - The entity is in pause state.\n* Rebooting - The entity reboot is in progress.\n* `` - The entity's power state is not available.

Type: CloudAwsVirtualMachine.PowerStateEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ProcessorCapacity

The capacity and usage information for CPU power on this virtual machine.

Note :- Use Initialize-IntersightVirtualizationComputeCapacity to create the object of complex type VirtualizationComputeCapacity

Type: VirtualizationComputeCapacity
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Provider

Cloud platform, where the virtual machine is launched.\n* Unknown - Cloud provider is not known.\n* VMwarevSphere - Cloud provider named VMware vSphere.\n* AmazonWebServices - Cloud provider named Amazon Web Services.\n* MicrosoftAzure - Cloud provider named Microsoft Azure.\n* GoogleCloudPlatform - Cloud provider named Google Cloud Platform.

Type: CloudAwsVirtualMachine.ProviderEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RegisteredDevice

A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: AssetDeviceRegistrationRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-State

The current state of the virtual machine. For example, starting, stopped, etc.\n* None - A place holder for the default value.\n* Creating - Virtual machine creation is in progress.\n* Pending - The virtual machine is preparing to enter the started state.\n* Starting - The virtual machine is starting.\n* Started - The virtual machine is running and ready for use.\n* Stopping - The virtual machine is preparing to be stopped.\n* Stopped - The virtual machine is shut down and cannot be used. The virtual machine can be started again at any time.\n* Pausing - The virtual machine is preparing to be paused.\n* Paused - The virtual machine enters into paused state due to low free disk space.\n* Suspending - The virtual machine is preparing to be suspended.\n* Suspended - Virtual machine is in sleep mode.When a virtual machine is suspended, the current state of theoperating system, and applications is saved, and the virtual machine put into a suspended mode.\n* Deleting - The virtual machine is preparing to be terminated.\n* Terminated - The virtual machine has been permanently deleted and cannot be started.\n* Rebooting - The virtual machine reboot is in progress.\n* Error - The deployment of virtual machine is failed.\n* Warning - The virtual machine is in warning state.

Type: CloudAwsVirtualMachine.StateEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Tags

Note :- Use Initialize-IntersightMoTag to create the object of complex type MoTag

Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Uuid

The uuid of this virtual machine. The uuid is internally generated and not user specified.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-VmCreationTime

Time when this virtualmachine is created.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Json

Returns the json payload received in response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

-WithHttpInfo

Returns the HTTP response with headers and content.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

EXAMPLES

Example 1

PS C:\> Set-IntersightCloudAwsVirtualMachine

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightCloudAwsVirtualMachine

Initialize-IntersightCloudAvailabilityZone

Initialize-IntersightCloudBillingUnit

Initialize-IntersightCloudCloudRegion

Initialize-IntersightCloudCloudTag

Initialize-IntersightCloudImageReference

Initialize-IntersightCloudInstanceType

Initialize-IntersightCloudNetworkInterfaceAttachment

Initialize-IntersightCloudVolumeAttachment

Initialize-IntersightInfraHardwareInfo

Initialize-IntersightMoVersionContext

Initialize-IntersightVirtualizationComputeCapacity

Initialize-IntersightVirtualizationGuestInfo

Initialize-IntersightVirtualizationMemoryCapacity