Set-HcsSystem

  • Article

Set-HcsSystem

Modifies settings for your StorSimple instance.

Syntax

Parameter Set: Default
Set-HcsSystem [-Name <String> ] [-Timezone <String> ] [ <CommonParameters>]

Detailed Description

The Set-HcsSystem cmdlet modifies settings for your StorSimple instance.

Parameters

-Name<String>

Specifies a name. The cmdlet assigns the friendly name that you specify to the device. This is not the DNS name or operating system name.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Timezone<String>

Specifies the time zone for the device, such as Eastern Standard Time or Mountain Standard Time.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

Outputs

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

  • Microsoft.HCS.Management.Platform.Support.SystemInfo

    The SystemInfo object has the following properties:

    -- Guid InstanceId
    -- String Name
    -- String Model
    -- String SerialNumber
    -- TimeZoneInfo TimeZone
    -- ControllerId CurrentController
    -- ControllerId ActiveController
    -- ControllerStatus Controller0Status
    -- ControllerStatus Controller1Status
    -- SystemMode @SystemMode
    -- Version HcsSoftwareVersion
    -- Version ApiVersion
    -- Version VhdVersion
    -- Version OSVersion
    -- UInt64 Capacity
    -- RemoteManagementMode RemoteManagementMode

    The ControllerId enumeration has the following values:

    -- Unknown = controller_id.CONTROLLER_ID_UNKNOWN
    -- None = controller_id.CONTROLLER_ID_NONE
    -- Controller0 = controller_id.CONTROLLER_ID_A
    -- Controller1 = controller_id.CONTROLLER_ID_B

    The ControllerStatus enumeration has the following values:

    -- Normal
    -- Recovery
    -- Unreachable

    The SystemMode enumeration has the following values:

    -- Normal
    -- Maintenance
    -- Decommissioned

    The RemoteManagementMode enumeration has the following values:

    -- HttpsAndHttpEnabled = 0
    -- HttpsEnabled = 1
    -- Disabled = 2

Examples

Example 1: Modify a device name

This command modifies the name of the device.

PS C:\> Set-HcsSystem -Name "Contoso03"

Example 2: Set the time zone

This command sets the time zone of the device to Eastern Standard Time.

PS C:\> Set-HcsSystem -Timezone "Eastern Standard Time"

CimInstance#MSFT_HCSSystem_Data