Skip to main content

Set-LXCASystemProperty

This cmdlet modifies the properties for a chassis, rack or tower server, RackSwitch switch, or rack storage device. You can set properties such as hostname, description, contact, and display name.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Set-LXCASystemProperty [-Connection LXCAConnection]
                        -ChassisUuid String
                       [-DisplayName String]
                       [-Hostname String]
                       [-Description String]
                       [-Contact String]
                       [-EncapsulationMode String]
                       [-Location  String]
                       [CommonParameter]

Set-LXCASystemProperty [-Connection LXCAConnection]
                        -ServerUuid String
                       [-DisplayName String]
                       [-Hostname String]
                       [-Description String]
                       [-Contact String]
                       [-EncapsulationMode String]
                       [-Location  String]
                       [CommonParameter]

Set-LXCASystemProperty [-Connection LXCAConnection]
                        -RackSwitchUuid String
                       [-DisplayName String]
                       [-Description String]
                       [-Contact String]
                       [-Location  String]
                       [CommonParameter]

Set-LXCASystemProperty [-Connection LXCAConnection]
                        -StorageUuid String
                       [-DisplayName String]
                       [-Description String]
                       [-Contact String]
                       [CommonParameter]

Parameters​

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-ChassisUuid String
Specifies the UUID of a chassis for which you want to set the properties.
-ServerUuid String
Specifies the UUID of a server for which you want to set the properties.
Note
The -RackServerUuid, -ThinkServerUuid and -ComputeNodeUuid aliases are supported for backward compatibility.
-RackSwitchUuid String
Specifies the UUID of a RackSwitch switch for which you want to set the properties.
-StorageUuid String
Specifies the UUID of a rack storage device for which you want to set the properties.
-DisplayName String
Specifies the display name value to be set.
-Hostname String
Specifies the hostname value to be set.
-Description String
Specifies the description value to be set.
-Contact String
Specifies the contact value to be set.
-EncapsulationMode String
Specifies the Encapsulation mode to be set. You can specify one of the following values.
  • normal. Encapsulation is disabled for this node.

    The global encapsulation setting is disabled by default. When disabled, the device encapsulation mode is set to normal and the firewall rules are not changed as part of the management process.

  • encapsulationLite. Encapsulation is enabled for this node.

    When the global encapsulation setting is enabled and the device supports encapsulation, XClarity Administrator communicates with the device during the management process to change the device encapsulation mode to encapsulationLite and to change the firewall rules on the device to limit incoming requests to those only from XClarity Administrator.

-Location String
Specifies the device location value to be set.

The location value can be 1 - 47 characters. You can use upper and lower case letter, number, and the following special characters: dash (-), underscore (_), and period (.). The first and last character cannot be a dash.

CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results​

This cmdlet sets the specified properties. No object is returned.

Examples​

The following example modifies the display name, contact, and location values for a chassis.

$cred = Get-Credential
Connect-LXCA -Host 192.0.2.0 -Credential $cred

Set-LXCASystemProperty -ChassisUuid AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -DisplayName "Display Name"`
                       -Contact "Admin"

Disconnect-LXCA