Skip to content

Latest commit

 

History

History
337 lines (254 loc) · 10 KB

Set-IntersightPowerPolicy.md

File metadata and controls

337 lines (254 loc) · 10 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightPowerPolicy

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightPowerPolicy [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-AllocatedBudget< long>][-Description< string>][-DynamicRebalancing< PowerPolicy.DynamicRebalancingEnum>][-ExtendedPowerCapacity< PowerPolicy.ExtendedPowerCapacityEnum>][[-Moid]< string>][-Name< string>][-Organization< OrganizationOrganizationRelationship>][-PowerPriority< PowerPolicy.PowerPriorityEnum>][-PowerProfiling< PowerPolicy.PowerProfilingEnum>][-PowerRestoreState< PowerPolicy.PowerRestoreStateEnum>][-PowerSaveMode< PowerPolicy.PowerSaveModeEnum>][-ProcessorPackagePowerLimit< PowerPolicy.ProcessorPackagePowerLimitEnum>][-Profiles< System.Collections.Generic.List`1[PolicyAbstractConfigProfileRelationship]>][-RedundancyMode< PowerPolicy.RedundancyModeEnum>][-Tags< System.Collections.Generic.List`1[MoTag]>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

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

-AllocatedBudget

Sets the allocated power budget of the chassis (in Watts).

Type: long
Parameter Sets: (All)
Aliases:

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

-Description

Description of the policy.

Type: string
Parameter Sets: (All)
Aliases:

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

-DynamicRebalancing

Sets the dynamic power rebalancing mode of the chassis. If enabled, this mode allows the chassis to dynamically reallocate the power between servers depending on their power usage.\n* Enabled - Set the value to Enabled.\n* Disabled - Set the value to Disabled.

Type: PowerPolicy.DynamicRebalancingEnum
Parameter Sets: (All)
Aliases:

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

-ExtendedPowerCapacity

Sets the Extended Power Capacity of the Chassis. If Enabled, this mode allows chassis available power to be increased by borrowing power from redundant power supplies. This option is only supported for Cisco UCS X series Chassis.\n* Enabled - Set the value to Enabled.\n* Disabled - Set the value to Disabled.

Type: PowerPolicy.ExtendedPowerCapacityEnum
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

Name of the concrete policy.

Type: string
Parameter Sets: (All)
Aliases:

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

-Organization

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

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

-PowerPriority

Sets the Power Priority of the Server. This priority is used to determine the initial power allocation for servers. This field is only supported for Cisco UCS B series and X series servers.\n* Low - Set the Power Priority to Low.\n* Medium - Set the Power Priority to Medium.\n* High - Set the Power Priority to High.

Type: PowerPolicy.PowerPriorityEnum
Parameter Sets: (All)
Aliases:

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

-PowerProfiling

Sets the Power Profiling of the Server. If Enabled, this field allows the power manager to run power profiling utility to determine the power needs of the server. This field is only supported for Cisco UCS X series servers.\n* Enabled - Set the value to Enabled.\n* Disabled - Set the value to Disabled.

Type: PowerPolicy.PowerProfilingEnum
Parameter Sets: (All)
Aliases:

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

-PowerRestoreState

Sets the Power Restore State of the Server. In the absence of Intersight connectivity, the chassis/server will use this policy to recover the host power after a power loss event.\n* AlwaysOff - Set the Power Restore Mode to Off.\n* AlwaysOn - Set the Power Restore Mode to On.\n* LastState - Set the Power Restore Mode to LastState.

Type: PowerPolicy.PowerRestoreStateEnum
Parameter Sets: (All)
Aliases:

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

-PowerSaveMode

Sets the power save mode of the chassis. If the requested power budget is less than available power capacity, the additional PSUs not required to comply with redundancy policy are placed in power save mode.\n* Enabled - Set the value to Enabled.\n* Disabled - Set the value to Disabled.

Type: PowerPolicy.PowerSaveModeEnum
Parameter Sets: (All)
Aliases:

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

-ProcessorPackagePowerLimit

Sets the Processor Package Power Limit (PPL) of a server. PPL refers to the amount of power that a CPU can draw from the power supply. The Processor Package Power Limit (PPL) feature is currently available exclusively on Cisco UCS C225/C245 M8 servers.\n* Default - Set the Package Power Limit to the platform defined default value.\n* Maximum - Set the Package Power Limit to the platform defined maximum value.\n* Minimum - Set the Package Power Limit to the platform defined minimum value.

Type: PowerPolicy.ProcessorPackagePowerLimitEnum
Parameter Sets: (All)
Aliases:

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

-Profiles

An array of relationships to policyAbstractConfigProfile resources.

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

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

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

-RedundancyMode

Sets the Power Redundancy Mode of the Chassis. Redundancy Mode determines the number of PSUs the chassis keeps as redundant. N+2 mode is only supported for Cisco UCS X series Chassis.\n* Grid - Grid Mode requires two power sources. If one source fails, the surviving PSUs connected to the other source provides power to the chassis.\n* NotRedundant - Power Manager turns on the minimum number of PSUs required to support chassis power requirements. No Redundant PSUs are maintained.\n* N+1 - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus one additional PSU for redundancy.\n* N+2 - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus two additional PSU for redundancy. This Mode is only supported for UCS X series Chassis.

Type: PowerPolicy.RedundancyModeEnum
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

-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-IntersightPowerPolicy

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightPowerPolicy

Initialize-IntersightMoVersionContext

New-IntersightPowerPolicy

Remove-IntersightPowerPolicy