Skip to content

Latest commit

 

History

History
498 lines (373 loc) · 15.6 KB

File metadata and controls

498 lines (373 loc) · 15.6 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightComputeServerSetting

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightComputeServerSetting [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-AdminLocatorLedState< ComputeServerSetting.AdminLocatorLedStateEnum>][-AdminPowerState< ComputeServerSetting.AdminPowerStateEnum>][-CertificatesAction< CertificatemanagementCertificateBase>][-ClearSel< ComputeServerSetting.ClearSelEnum>][-CmosReset< ComputeServerSetting.CmosResetEnum>][-CollectSel< ComputeServerSetting.CollectSelEnum>][-FrontPanelLockState< ComputeServerSetting.FrontPanelLockStateEnum>][-HostInitConfiguration< string>][-KvmReset< ComputeServerSetting.KvmResetEnum>][[-Moid]< string>][-OneTimeBootDevice< string>][-PersistentMemoryOperation< ComputePersistentMemoryOperation>][-PersonalitySetting< ComputePersonalitySetting>][-ResetMemoryErrors< ComputeServerSetting.ResetMemoryErrorsEnum>][-ServerConfig< ComputeServerConfig>][-ServerOpStatus< System.Collections.Generic.List`1[ComputeServerOpStatus]>][-StorageControllerOperation< ComputeStorageControllerOperation>][-StoragePhysicalDriveOperation< ComputeStoragePhysicalDriveOperation>][-StorageUtilityImageOperation< ComputeStorageUtilityImageOperation>][-StorageVirtualDriveOperation< ComputeStorageVirtualDriveOperation>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TpmReset< ComputeServerSetting.TpmResetEnum>][-TunneledKvmState< ComputeServerSetting.TunneledKvmStateEnum>][-IfMatch< String>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

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

-AdminLocatorLedState

User configured state of the locator LED for the server.\n* None - No operation property for locator led.\n* On - The Locator Led is turned on.\n* Off - The Locator Led is turned off.

Type: ComputeServerSetting.AdminLocatorLedStateEnum
Parameter Sets: (All)
Aliases:

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

-AdminPowerState

User configured power state of the server.\n* Policy - Power state is set to the default value in the policy.\n* PowerOn - Power state of the server is set to On.\n* PowerOff - Power state is the server set to Off.\n* PowerCycle - Power state the server is reset.\n* HardReset - Power state the server is hard reset.\n* Shutdown - Operating system on the server is shut down.\n* Reboot - Power state of IMC is rebooted.

Type: ComputeServerSetting.AdminPowerStateEnum
Parameter Sets: (All)
Aliases:

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

-CertificatesAction

Certificates Action configures the Certificate and PrivateKey at the endpoint.

Note :- Use Initialize-IntersightCertificatemanagementCertificateBase to create the object of complex type CertificatemanagementCertificateBase

Type: CertificatemanagementCertificateBase
Parameter Sets: (All)
Aliases:

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

-ClearSel

Clear system event log on a server.\n* Ready - Clear system event log operation is allowed on the server in this state.\n* Clear - Trigger a clear system event log operation on a server.

Type: ComputeServerSetting.ClearSelEnum
Parameter Sets: (All)
Aliases:

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

-CmosReset

The allowed actions on the CMOS Reset.\n* Ready - CMOS Reset operation is allowed to be done on the server in this state.\n* Pending - The identifier to state that the previous CMOS Reset operation on this server has not completed due to a pending power cycle. CMOS Reset operation cannot be done on the server when in this state.\n* Reset - The value that the UI/API needs to provide to trigger a CMOS Reset operation on a server.

Type: ComputeServerSetting.CmosResetEnum
Parameter Sets: (All)
Aliases:

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

-CollectSel

Collect system event log from a server.\n* Ready - Collect system event log operation is allowed on the server in this state.\n* Collect - Trigger a collect system event log operation on a server.

Type: ComputeServerSetting.CollectSelEnum
Parameter Sets: (All)
Aliases:

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

-FrontPanelLockState

The allowed actions on the Front Panel Lock.\n* None - Front Panel of the server is set to None state. It is required so that the next frontPanelLockState operation can be triggered.\n* Lock - Front Panel of the server is set to Locked state.\n* Unlock - Front Panel of the server is set to Unlocked state.

Type: ComputeServerSetting.FrontPanelLockStateEnum
Parameter Sets: (All)
Aliases:

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

-HostInitConfiguration

The JSON formatted host initialization configuration containing the basic information for doing an initial boot. The information will be sent to CIMC and stored in host-init.json file on the server. The stored file can only be access using IPMI tool on the host OS.

Type: string
Parameter Sets: (All)
Aliases:

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

-KvmReset

The allowed actions on the vKVM Reset.\n* Ready - Reset vKVM operation is allowed to be done on the server in this state.\n* Reset - The value that the UI/API needs to provide to trigger a Reset vKVM operation on a server.

Type: ComputeServerSetting.KvmResetEnum
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

-OneTimeBootDevice

The name of the device chosen by user for configuring One-Time Boot device.

Type: string
Parameter Sets: (All)
Aliases:

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

-PersistentMemoryOperation

The Persistent Memory Modules operation properties.

Note :- Use Initialize-IntersightComputePersistentMemoryOperation to create the object of complex type ComputePersistentMemoryOperation

Type: ComputePersistentMemoryOperation
Parameter Sets: (All)
Aliases:

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

-PersonalitySetting

The personality value to be set on the server. Any additional information like the hypervisor type, last update time can also be set through this server setting.

Note :- Use Initialize-IntersightComputePersonalitySetting to create the object of complex type ComputePersonalitySetting

Type: ComputePersonalitySetting
Parameter Sets: (All)
Aliases:

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

-ResetMemoryErrors

Reset Correctable and Uncorrectable ECC errors on all the DIMMs present in the server.\n* Ready - Reset memory errors operation is allowed on the server in this state.\n* Reset - Trigger reset memory errors operation on a server.

Type: ComputeServerSetting.ResetMemoryErrorsEnum
Parameter Sets: (All)
Aliases:

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

-ServerConfig

The common server configurable properties between a server and a server profile.

Note :- Use Initialize-IntersightComputeServerConfig to create the object of complex type ComputeServerConfig

Type: ComputeServerConfig
Parameter Sets: (All)
Aliases:

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

-ServerOpStatus

Note :- Use Initialize-IntersightComputeServerOpStatus to create the object of complex type ComputeServerOpStatus

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

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

-StorageControllerOperation

The Storage Controller operation properties.

Note :- Use Initialize-IntersightComputeStorageControllerOperation to create the object of complex type ComputeStorageControllerOperation

Type: ComputeStorageControllerOperation
Parameter Sets: (All)
Aliases:

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

-StoragePhysicalDriveOperation

The Storage Physical Drives operation properties.

Note :- Use Initialize-IntersightComputeStoragePhysicalDriveOperation to create the object of complex type ComputeStoragePhysicalDriveOperation

Type: ComputeStoragePhysicalDriveOperation
Parameter Sets: (All)
Aliases:

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

-StorageUtilityImageOperation

The storage utility image operation properties.

Note :- Use Initialize-IntersightComputeStorageUtilityImageOperation to create the object of complex type ComputeStorageUtilityImageOperation

Type: ComputeStorageUtilityImageOperation
Parameter Sets: (All)
Aliases:

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

-StorageVirtualDriveOperation

The Storage Virtual Drives operation properties.

Note :- Use Initialize-IntersightComputeStorageVirtualDriveOperation to create the object of complex type ComputeStorageVirtualDriveOperation

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

-TpmReset

Clear the configuration of TPM chip in the server.\n* None - Perform no action on the TPM.\n* ClearTpm - Clear the configuration and restore factory defaults of TPM chip in the server.

Type: ComputeServerSetting.TpmResetEnum
Parameter Sets: (All)
Aliases:

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

-TunneledKvmState

By default, the tunneled vKVM property appears in Ready state. The property can be configured by performing allowed actions. Once the property is configured, it reverts to Ready state.\n* Ready - Tunneled vKVM is ready to be configured on the server.\n* Enable - Tunneled vKVM is enabled for the server.\n* Disable - Tunneled vKVM is disabled for the server.

Type: ComputeServerSetting.TunneledKvmStateEnum
Parameter Sets: (All)
Aliases:

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

-IfMatch

For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.

Type: String
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
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-IntersightComputeServerSetting

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightComputeServerSetting

Initialize-IntersightCertificatemanagementCertificateBase

Initialize-IntersightComputePersistentMemoryOperation

Initialize-IntersightComputePersonalitySetting

Initialize-IntersightComputeServerConfig

Initialize-IntersightComputeServerOpStatus

Initialize-IntersightComputeStorageControllerOperation

Initialize-IntersightComputeStoragePhysicalDriveOperation

Initialize-IntersightComputeStorageUtilityImageOperation

Initialize-IntersightComputeStorageVirtualDriveOperation

Initialize-IntersightMoVersionContext