Skip to content

Latest commit

 

History

History
245 lines (181 loc) · 5.13 KB

Set-IntersightKvmSession.md

File metadata and controls

245 lines (181 loc) · 5.13 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightKvmSession

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightKvmSession [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-KvmLaunchUrlPath< string>][-KvmSessionId< string>][[-Moid]< string>][-OneTimePassword< string>][-Server< ComputePhysicalRelationship>][-Status< KvmSession.StatusEnum>][-Tags< System.Collections.Generic.List`1[MoTag]>][-Tunnel< KvmTunnelRelationship>][-Username< string>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'KvmSession' 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

-KvmLaunchUrlPath

One time URL that is used to launch the vKVM console.

Type: string
Parameter Sets: (All)
Aliases:

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

-KvmSessionId

Unique ID of the KVM Session URI.

Type: string
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

-OneTimePassword

Temporary one-time password for vKVM access.

Type: string
Parameter Sets: (All)
Aliases:

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

-Server

A reference to a computePhysical 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: ComputePhysicalRelationship
Parameter Sets: (All)
Aliases:

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

-Status

The status of the session.\n* Active - The session is currently active.\n* Ended - The session has ended normally.\n* Terminated - The session was terminated by an admin.

Type: KvmSession.StatusEnum
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

-Tunnel

A reference to a kvmTunnel 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: KvmTunnelRelationship
Parameter Sets: (All)
Aliases:

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

-Username

Username used for vKVM access.

Type: string
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-IntersightKvmSession

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightKvmSession

Initialize-IntersightMoVersionContext

New-IntersightKvmSession