Set-ContainerMemory

Set-ContainerMemory

Sets the maximum memory usage of a container.

Syntax

Parameter Set: Container Name
Set-ContainerMemory [-ContainerName] <String[]> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-MaximumBytes <Int64> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Container Object
Set-ContainerMemory [-Container] <Container[]> [-MaximumBytes <Int64> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ResourceObject
Set-ContainerMemory [-ContainerMemory] <ContainerMemory[]> [-MaximumBytes <Int64> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-ContainerMemory cmdlet sets the maximum memory usage of a container.

Parameters

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts to run the cmdlet. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Container<Container[]>

Specifies the container whose memory you want to configure.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-ContainerMemory<ContainerMemory[]>

Specifies the container memory you want to configure.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-ContainerName<String[]>

Specifies the name of the container whose memory you want to configure.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential[]>

Specifies a user account that has permission to perform this action. The default is the current user.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MaximumBytes<Int64>

Specifies the maximum amount of memory to be used by the container.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Passthru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None.


Examples

Example 1: Set the maximum container memory

This command sets the maximum bytes of memory for the container named MyContainer to 2048 MB.


PS C:\> Set-ContainerMemory -ContainerName "MyContainer" -MaximumBytes 2048MB

Related topics

Community Additions

Show: