SigmaSystemCenter 2.1 SSC Command Reference

Transcription

1 SigmaSystemCenter 2.1 SSC Command Reference - First Edition -

2 Copyright (C) NEC Corporation All rights reserved. Disclaimer of Warranty All the information, text, graphics, links or other items contained within this document is provided by copyright law. All Rights Reserved. No part of this document may be reproduced or transmitted without permission of NEC. NEC may make changes to this document, at any time without notice. NEC assumes no responsibility for errors or omissions in this document. THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. NEC does not warrant the accuracy or completeness of this document. Trademark Information Microsoft, Windows, Windows Server, Microsoft Internet Explorer, SQL Server, and Hyper-V are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Linux is a registered trademark or trademark of Linus Torvalds in the United States and/or other countries. SUSE is a registered trademark or trademark of Novell, Inc., in the United States and/or other countries. Red Hat is a registered trademark or trademark of Red Hat, Inc. in the United States and/or other countries. Intel, Pentium, Itanium, and Xeon are trademarks of Intel Corporation in the U.S. and other countries. AMD is a trademark of Advanced Micro Devices, Inc. EMC, Symmetrix, CLARiiON, and Navisphere are registered trademarks of EMC Corporation in the United States and other countries. VMware, ESX, ESXi, and VMotion are registered trademarks or trademarks of VMware, Inc. in the United States and other countries. Xen, Citrix, XenServer, and XenCenter are registered trademarks or trademarks of Citrix Systems, Inc. PXE Software Copyright (C) Intel Corporation. Copyright (C) 2005, 2007, ALAXALA Networks Corporation. All rights reserved. (C) Cisco Systems Inc. All rights reserved. Foundry Networks, FastIron, ServerIron and the 'Iron' family of marks are trademarks or registered trademarks of Foundry Networks, Inc. in the United Status and other countries. BIG-IP is a registered trademark of F5 Networks, Inc. in the United States and/or other countries. InstallShield is a registered trademark and service mark of Macrovision Corporation and/or Macrovision Europe Ltd. in the United States and/or other countries. Java and all Java related trademarks are registered trademarks of Sun Microsystems, Inc. in the United States and other countries. This product includes software developed by the Apache Software Foundation. This product contains JRE (Java Runtime Environment), which is distributed by Sun Microsystems, Inc. without charge, and Tomcat, which is distributed by Apache Software Foundation without charge. Use these products after accepting their license agreements. For details of copyright and ownership rights, refer to the following license files: Tomcat: folder where Tomcat is installed\license JRE: folder where JRE is installed\license

3 Some icons used in this program are based on Silk Icons released by Mark James under a Creative Commons Attribution 2.5 License. Visit for more details. All other brands and products used in this document are the trademarks or registered trademarks of their respective trademark holders. The (R) and TM marks are not explicitly in this document.

4

5 Contents Preface... v How to Use This Manual... v Manual Organization... v SigmaSystemCenter Manuals... vi Document Conventions... viii 1. About SSC Command SSC Command Conditions to Use SSC Commands and Supplementary Information Symbols Common Options Return Values of SSC Command Command for Setup License Adding License Deleting License Displaying Licenses Environment Setting Updating Environment Setting Subsystem Adding Subsystem Collect Collecting Information Machine Registering Machine Unregistering Machine Allocate Machine, Register Master Machine, or Add Machine to Pool Release or Delete From Pool Displaying Machine Machine Account Creating Machine Account Updating Machine Account Deleting Machine Account Displaying Machine Account Group Creating Group Updating Group Setting Displaying Group Setting Host Creating Host Updating Host Displaying Host Definition IP Address Adding IP Address Information Software Adding Software Storage Adding Storage VLAN Adding VLAN Load Balancer Adding Load Balancer Command for Controlling Configuration of Virtual Environment iii

6 3.1. Operations for Virtual Machine Server Adding Virtual Machine Server Deleting Virtual Machine Server Changing Password of Virtual Machine Server Post-Processing of Virtual Machine Server Recovery Evacuating Machine Operations for Virtual Machine Changing Configuration of Virtual Machines Moving Virtual Machine (Migrate) Moving Virtual Machine (Move) Evacuating Machine (Host Specified) Optimized Placement Rule Configuring Optimized Placement Rule Releasing Optimized Placement Rule Enabling Optimized Placement Rule Disabling Optimized Placement Rule Placement by Optimized Placement Rule Displaying Optimized Placement Rule Command for Maintenance Operations Log Displaying Operations Log Policy Exporting Policy Importing Policy Maintenance Maintaining Configuration Information...80 iv

7 Preface How to Use This Manual SigmaSystemCenter SSC Command Reference is intended for system administrators and explains various ssc commands. Manual Organization 1 "About SSC Command": Explains about the ssc commands that can be used with the ssc command line tool. 2 "Command for Setup": Explains commands regarding setting up SigmaSystemCenter. 3 "Command for Controlling Configuration of Virtual Environment": Explains commands regarding the configuration control of the virtual environment that can be managed in SigmaSystemCenter. 4 "Command for Maintenance": Explains commands regarding maintenance in SigmaSystemCenter. v

8 SigmaSystemCenter Manuals The manuals of SigmaSystemCenter are configured for the various products and components as follows. In this manual, each of the following manuals is described as "How Manuals Are Called in This Manual." Products or Manuals How Manuals Are Called in This Components Manual SigmaSystemCenter 2.1 ESMPRO/ServerManager 4.42 DeploymentManager 5.21 SystemMonitor 性能監視 SigmaSystemCenter 2.1 First Step Guide SigmaSystemCenter 2.1 Installation Guide SigmaSystemCenter 2.1 Configuration Guide SigmaSystemCenter 2.1 Reference Guide ESMPRO/ServerManager User s Guide DeploymentManager System Introduction Ver.5.2 DeploymentManager (Basic) User s Guide Ver.5.2 DeploymentManager (Advanced) User s Guide Ver.5.2 DeploymentManager (PackageDescriber) User s Guide Ver.5.2 SystemMonitor 性能監視 User s Guide SigmaSystemCenter First Step Guide SigmaSystemCenter Installation Guide SigmaSystemCenter Configuration Guide SigmaSystemCenter Reference Guide ESMPRO/ServerManager User s Guide DeploymentManager System Introduction DeploymentManager Basic User s Guide DeploymentManager Advanced User s Guide DeploymentManager PackageDescriber User s Guide SystemMonitor 性能監視 User s Guide Reference: All the latest SigmaSystemCenter manuals are available in the following URL. vi

9 The information regarding product summery, installation, configuration, operation and maintenance of SigmaSystemCenter are included in the following four manuals. The purposes of the manuals are as follows. SigmaSystemCenter First Step Guide This manual is intended for users who use SigmaSystemCenter for the first time and explains the product summery, system design methods and operating environment. SigmaSystemCenter Installation Guide This manual is intended for system administrators who install, upgrade, or uninstall SigmaSystemCenter and explains how to. SigmaSystemCenter Configuration Guide This manual is intended for system administrators who configure the whole system after installation and who operate and maintain the system after the configuration. Actual operational flow is used to explain the process from the configuration after installation to the operating procedures. This manual also explains the maintenance process. SigmaSystemCenter Reference Guide This manual is intended for administrators of SigmaSystemCenter and explains its functions, the operational methods, information of maintenance and trouble shooting, and lists all the operating screens. This manual is a supplement to SigmaSystemCenter Installation Guide and SigmaSystemCenter Configuration Guide. vii

10 Document Conventions In this manual, information that needs attention and references are described as follows: Note: indicates caution notes, and supplementary explanation for functions, operations, and settings. Reference: indicates why and where you should refer to. In addition, this manual uses the following document conventions. Convention Used Item Example Bold font Items that a user selects on a screen, short text input, screen names, short command-line commands, and command-line options Type Exit and click Enter. User License Confirmation screen Use the prt command. Use the /a option. Italic font Book or manual titles, and variable names Configuration Guide add GroupName Quotation marks Chapter titles and default values See Chapter 9, "Add a Computer." Monospace font (courier new) Long text inputs, messages and command-line commands Type the following text: Confidential-Class B viii

11 1. About SSC Command This chapter explains about the ssc commands of SigmaSystemCenter. This chapter contains the following sections: 1.1 SSC Command

12 1 About SSC Command 1.1. SSC Command With the ssc command line tool, you can set various settings to multiple managed machines collectively by executing commands from a BAT file. This function dramatically reduces the burden of configuring large scale environment. In addition, some functions, including settings for configuration changes in the virtual environment, support operations only by the ssc command. The ssc command provides you the following functions: Command (Function) create add update delete Subcommand group host license manager ipaddress software storage vlan lb vmserver environment group host vmproperty license vmserver Explanation Creates a group. Creates a host in a group. Adds a license. Adds a subsystem. Adds an IP address (network) to a host in a group. Adds software in a group (group or model) or a distribution point of a host. Adds a disk volume of a disk array to a host in a group. Adds a VLAN in a group. Specify a NIC number, switch, and VLAN to add in a group. Adds a load balancer in a group. Adds a virtual machine server in a datacenter. Sets environment settings. Edits and updates settings of a group. Edits and updates settings of a host. Edits virtual machines collectively. Deletes a license. Deletes a virtual machine server from a datacenter. collect - Collects information of a specified target. register machine Registers a machine in a resource group or rack. unregister machine Unregisters a machine from a resource group or rack. assign machine Executes Allocate Machine, Register Master Machine, or Add to Pool. release (releasing assignment or releasing from a pool) machine Releases assignment of a machine or deletes a machine from a pool. change-passwd - Changes a password of a virtual machine server. 10 SigmaSystemCenter 2.1 SSC Command Reference

13 SSC Command Command (Function) migrate (moving a virtual machine) move (moving a virtual machine) vmop (placement constraint) Subcommand machine machine set-rule delete-rule enable-rule disable-rule apply-rule show-rule Explanation Moves (migrate) a virtual machine. Moves (move) a virtual machine. Sets placement constraint of virtual machines. Deletes placement constraint of virtual machines. Enables placement constraint of virtual machines. Disables placement constraint of virtual machines. Places virtual machines according to placement constraint. Displays placement constraint settings of virtual machines. recover machine Recovers a virtual machine server. evacuate machine-account (creating, updating, deleting, and displaying) machine host create update delete show Evacuates virtual machines on a virtual machine server to other virtual machine server. Evacuates virtual machines on a virtual machine server to other virtual machine server (with a host specified). Creates a machine account. Updates a machine account. Deletes a machine account. Displays machine account information. export policy Outputs policy information to an XML file. import policy Imports policy information from an XML file. maintenance cmdb Maintains the configuration database. show license group host machine log Displays licenses. Displays settings of a group. Displays settings of a host. Displays machines in a resource group in a list. Displays the Operations log. 11

14 1 About SSC Command Conditions to Use SSC Commands and Supplementary Information The following conditions must be met to use the ssc command: Only users with administrator rights that are valid to OS (Windows Server 2003, for example) on a management server can execute the ssc commands. Note: If the User Account Control, UAC, is valid, you need to execute with the Administrator mode. For example, right-click Command Prompt and click Run as administrator to launch the pvmutl commands. Group names can be specified in the format of "category\group." If a group has no category, the category part can be omitted. You can also specify a model in a group. If you specify a model, specify in the format of "category\group\model." About backing up the database The ssc command provides you various useful functions, such as configuring hosts collectively; however, if a specified command is wrong, in the case that the command is executed automatically by BAT command without advance verification, for example, unintended settings can be configured. Extract backup of database in advance so that you can restore the condition of before executing the command in such cases. Reference: For how to back up, see Chapter 9, "Backup and Restoration" in SigmaSystemCenter Configuration Guide. If a resource name (machine name, host name, group name, etc) starts with "-" (a hyphen) If you specify a resource name that starts with "-" (a hyphen) in a command, the system may not cognize whether the name is a resource name or option specification. If a resource name that starts with "-" (a hyphen) exists, change the name and execute a command or execute the operation from the Web Console. 12 SigmaSystemCenter 2.1 SSC Command Reference

15 SSC Command Symbols The following symbols are used in the explanation of the functions of ssc commands. [ ] (brackets) indicate optional items. (vertical line) is a separator indicating that you can select either of the separated items. <> is an option that you need to specify Common Options The following options can be used commonly in the ssc commands. If you do not specify parameters when you start ssc from command line, the system displays help. ssc [option1] [option2] command [subcommand...] [parameter ] [cmd option [option parameter]...] You can use the following options to [option1]. -v --verbose -q --quiet -d --debug A mode to get the command to work, outputting status, such as command execution status A mode to get the command to work with no message outputted (This mode is suitable for batch execution.) A mode to get the command to work with debug messages outputted You can use the following options to [option2]. -h --help help --ver Outputs command help. If the following parameter is inputted, a command narrowed down to the parameter as a key. If there is no target command, help for all commands are outputted. Outputs version information. --version 13

16 1 About SSC Command You can use the following options to [cmd option]. -h -help Outputs parameter explanation (help) for each command Return Values of SSC Command The execution results of ssc commands can be determined by their return values. Return values of ssc commands are as follows: Values Success/Failure Causes 0 Succeeded 1 Failed A command format error, such as insufficient parameters 2 Failed An error regarding an account 3 Failed An error regarding a specified group 4 Failed An error regarding command execution 5 Failed An error regarding acquiring Job information 6 Failed An error regarding UC connection 7 Failed An error of Job execution 10 Failed Other system exceptions 14 SigmaSystemCenter 2.1 SSC Command Reference

17 2. Command for Setup This chapter explains commands regarding setting up SigmaSystemCenter. This chapter contains the following sections: 2.1 License Environment Setting Subsystem Collect Machine Machine Account Group Host IP Address Software Storage VLAN Load Balancer

18 2 Command for Setup 2.1. License Adding License Adds a license. Register an edition license first. To enable the setting, you need to restart SystemProvisioning. However, if you add only target licenses, you do not need to restart SystemProvisioning. ssc add license LicenseKey LicenseKey Specify a target license key. >ssc add license xxxxx-xxxxx-xxxxx-xxxxx-xxxxx Deleting License Deletes a license. ssc delete license LicenseKey LicenseKey Specify a target license key. >ssc delete license xxxxx-xxxxx-xxxxx-xxxxx-xxxxx 16 SigmaSystemCenter 2.1 SSC Command Reference

19 License Displaying Licenses Displays licenses. ssc show license Parameters are not variable. >ssc show license 17

20 2 Command for Setup 2.2. Environment Setting Updating Environment Setting Configures environment settings. ssc update environment Key Value Key Specify an item to configure in the following Keys: "VMSDefaultCapacity": Configure the initial capacity value of a virtual machine server referenced when moving virtual machines by policy operations. This value can be specified from 1 to The default value is "200." "VMDefaultCost": Configure the initial cost value of the virtual machine referenced when moving virtual machines by policy operations. This value can be specified from 1 to The default value is "10." "VMSRootPassword": Configure the default password of a virtual machine server referenced when restoring an ESX or executing failover. Value Specify a value for the item specified in Key. >ssc update environment VMSDefaultCapacity 1 18 SigmaSystemCenter 2.1 SSC Command Reference

21 Subsystem 2.3. Subsystem Adding Subsystem Adds a subsystem. ssc add manager Type [-name HostName] [-account Account] [-port PortNumber] [-url URL] [-p Password] Type [-name HostName] [-account Account] [-port PortNumber] [-url URL] [-p Password] Specify a subsystem to add in the following Types: "dpm": Web Server for DPM "virtualcenter": VMware VirtualCenter "esxi": ESXi "xen": Citrix XenServer Pool Master "hyper-v": Hyper-V Specify a host name or IP address of a server on which the target is installed. If you specify its URL, a host name is automatically created, and you do not need to specify this item. Specify an account name of the target. Specify a port number of the target. Specify a URL of the target. If you specify HostName, a URL is automatically generated, and you do not need to specify this item. Specify a password registered to the target. If you specify "esxi" or "hyper" in Type, you cannot specify the options; -name, -account, -port, -url, and -p. If you specify "dpm" in Type, you need to specify -name and -p. If you specify "virtualcenter" or "xen" in Type, you need to specify -account and -p. 19

22 2 Command for Setup >ssc add manager esxi >ssc add manager hyper-v >ssc add manager dpm -name port 8080 p xxxxx >ssc add manager virtualcenter -name account user01 -port 443 -url " -p xxxxx >ssc add manager xen -name account user02 p xxxxx 20 SigmaSystemCenter 2.1 SSC Command Reference

23 Collect 2.4. Collect Collecting Information Collects information. ssc collect Type <[-name Name] [-uuid Uuid] [-path Path]> Type [-name Name] [-uuid Uuid] [-path Path] Specify a target from which you want to collect information in the following Types: "all": All subsystems "vms": Virtual machine servers "machine": Physical machines, virtual machine servers, and virtual machines Specify a target host name or IP address of the target. This value is enabled if Type is not "all". You can specify multiple items. Specify UUID of the target. This value is enabled if Type is "machine". You can specify multiple UUIDs. Specify a full path of the target. >ssc collect all >ssc collect vms name >ssc collect vms -path virtual:/manager/datacenter/vmserver >ssc collect machine uuid xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 21

24 2 Command for Setup 2.5. Machine Registering Machine Registers a machine in a resource group or rack. ssc register machine GroupName MachineName[...] [-e] [-n] GroupName MachineName[...] [-e] [-n] Specify a resource group or rack in which you want to register a machine. Specify a path to the resource group or rack. Specify a target machine. You cannot specify a machine running in an operation group or standing by. You can specify multiple machines. Creates a group specified in GroupName. Moves a resource in the Machine icon in the System Resource tree. If you specify all resources in the Machine icon, specify "/" in MachineName. >ssc register machine Group1 machine01 >ssc register machine Group1/Rack01 machine02 machine03 >ssc register machine Group1/Group2 machine04 >ssc register machine Group1/Group2/Group3 machine05 e >ssc register machine Group1 / -n 22 SigmaSystemCenter 2.1 SSC Command Reference

25 Machine Unregistering Machine Unregisters a machine from a resource group or rack. ssc unregister machine GroupName MachineName[...] GroupName MachineName[...] Specify a resource group or rack in which a machine that you want to unregister is registered. Specify a path to the resource group or rack. If you specify only "/", all managed machines in the Machine icon in the System Resource tree become the targets. Specify a target machine name. You cannot specify a machine running in an operation group or standing by. You can specify multiple machines. >ssc unregister machine / machine01 >ssc unregister machine Group1 machine02 >ssc unregister machine Group1/Rack01 machine03 machine04 >ssc unregister machine Group1/Group2 machine05 23

26 2 Command for Setup Allocate Machine, Register Master Machine, or Add Machine to Pool Executes Allocate Machine, Register Master Machine, or Add Machine to Pool. ssc assign machine GroupName [MachineName...] [<[-sharedpool] [-master] [-addpool]>] [-host HostName] GroupName [MachineName...] [-sharedpool] [-master] [-addpool] [-host HostName] Specify the group to which you are to allocate a machine, register a machine, or whose pool you are to add a machine. Specify a path to the group or model. You cannot specify a category. (E.g. Category/Group, Category/Group/Model) Specify a machine name that you want to allocate, register, or add to a pool. If you do not specify MachineName, machines in a group pool become targets. If you specify -sharedpool, -master, or -addpool, you cannot omit this option. You can specify multiple machines. Specify this option to add a machine in the shared pool to a group. If you do not specify this option, a machine in a group pool is added to a group. You cannot specify this option along with -master and -addpool. Specify this option to execute Register Master Machine. If you do not specify this option, a machine in a group pool is added to a group. You cannot specify this option along with -sharedpool and -addpool. Specify this option to add a machine to a pool. You cannot specify this option along with -sharedpool, -master, and -host HostName. Specify a name of a host with which a target machine is activated. If you specify -master, you cannot omit this option. You cannot specify this option along with -addpool. 24 SigmaSystemCenter 2.1 SSC Command Reference

27 Machine 1) Scale Out >ssc assign machine Category/Group1/Model001 2) Allocate Machine from a group pool >ssc assign machine Category/Group1/Model001 machine001 >ssc assign machine Category/Group1/Model001 machine002 -host host002 >ssc assign machine Category/Group1/Model001 -host03 3) Allocate Machine from the shared pool >ssc assign machine Category/Group1/Model001 -sharedpool machine001 >ssc assign machine Category/Group1/Model001 -sharedpool machine002 -host host002 4) Register Master Machine >ssc assign machine Category/Group1/Model001 -master machine001 -host host001 5) Add Machine to Pool >ssc assign machine Category/Group1/Model001 -addpool machine001 machine002 25

28 2 Command for Setup Release or Delete From Pool Releases assignment of a machine or deletes a machine from a pool. ssc release machine GroupName <[HostName...] [-sharedpool] [-force] -del MachineName[...]> GroupName [HostName...] [-sharedpool] [-force] -del Specify the group from which you are to release or delete a machine. Specify a path to the group. You cannot specify a category or model. (E.g. Category/Group) Specify a name of a host with which a target machine is running. If you do not specify this option, a running machine is selected automatically and is returned to a group pool. If you specify -sharedpool or -force, you cannot omit this option. You cannot specify this option along with -del. You can specify multiple hosts. Returns a running machine from group to the shared pool. If you do not specify this option, the machine is returned to a group pool. If you specify this option, you cannot omit HostName. You cannot specify this option along with -del. Releases assignment forcedly by operating the database. If you do not specify this option, a Job is executed. If you specify this option, you cannot omit HostName. However, you cannot specify multiple host names. You cannot specify this option along with -sharedpool and -del. Specify this parameter to delete a target machine from a pool. You cannot specify this option along with HostName, -sharedpool, and -force. 26 SigmaSystemCenter 2.1 SSC Command Reference

29 Machine MachineName[...] Specify a name of a machine to delete from a pool. If you specify -del, you cannot omit this parameter. You cannot specify this option along with HostName, -sharedpool and -force. 1) Scale In >ssc release machine Category/Group1/Model001 2) Wait in a group pool >ssc release machine Category/Group1/Model001 host001 3) Return to the shared pool >ssc release machine Category/Group1/Model001 host001 -sharedpool 4) Return from a pool to the shared pool >ssc release machine Category/Group1/Model001 del machine001 machine002 27

30 2 Command for Setup Displaying Machine Displays machines in your system resource in a list. The list is outputted in the csv format (in one line divided with commas). ssc show machine [-ms <on off>] [-ms <on off>] Specify management state of machines to display. If you specify "on", machines that are being managed are displayed. If you specify "off", machines that are out of management are displayed. If you do not specify this option, all machines are displayed. >ssc show machine >ssc show machine ms on >ssc show machine ms off 28 SigmaSystemCenter 2.1 SSC Command Reference

31 Machine Account 2.6. Machine Account Creating Machine Account Creates an account of a managed machine or unmanaged machine. In SigmaSystemCenter, you can configure an account for each connection type used in management, monitoring, and controlling managed machines. ssc machine-account create < -uuid UUID -machine MachineName > -type ConnectionType -ip IPAddress -u UserName [-p Password] [-overwrite] < -uuid UUID -machine MachineName > -type ConnectionType -ip IPAddress -u UserName [-p Password] [-overwrite] Specify UUID of a machine or a name of the machine to which you are to register an account. You can specify an unmanaged machine. Specify a connection type. Only "oob" is supported. OOB is used for Out-of-Band-Management. Specify an IP address. Specify a user name. Depending on a login system of a connection destination, a specification might be case sensitive. Specify a password. If you do not specify this option, no password is specified. If you specify a null character ("") in Password, the password is regarded as not specified. If a machine account is already registered, overwrites the account. If you do not specify this option, if an account is already registered, an error occurs. 29

32 2 Command for Setup >ssc machine-account create -machine SV0100 -type oob -ip u User01 -p xxxxxx >ssc machine-account create -uuid 7DEB0F09-0BC6-495f-9CF6-A15EBC88BCC9 -type oob -ip u User02 >ssc machine-account create -machine SV0200 -type oob -ip u User01 -p "" -overwrite >ssc machine-account update -uuid 1CC9EBCC d-84D2-B2F168690BC8 -type oob -p xxxxxxx Updating Machine Account Updates an account of a managed machine or unmanaged machine. ssc machine-account update < -uuid UUID -machine MachineName > -type ConnectionType [-ip IPAddress] [-u UserName] [-p Password] < -uuid UUID -machine MachineName > -type ConnectionType [-ip IPAddress] [-u UserName] [-p Password] Specify a UUID of a target machine or machine name. Specify a connection type. Only "oob" is supported. OOB is used for Out-of-Band-Management. Specify an IP address to update. Specify a user name to update. Depending on a login system of a connection destination, a specification might be case sensitive. Specify a password to update. If you specify a null character (""), the password is deleted. You cannot omit all of the -ip, -u, and -p options. 30 SigmaSystemCenter 2.1 SSC Command Reference

33 Machine Account >ssc machine-account update -machine SV0100 -type oob -ip u User01a -p xxxxxx >ssc machine-account update -uuid 1CC9EBCC d-84D2-B2F168690BC8 -type oob -ip >ssc machine-account update -machine SV0200 -type oob -u User02a >ssc machine-account update -uuid 3571C728-EE55-4a43-A8AE-DDDA3ED8EBA0 -type oob -p xxxxxxx Deleting Machine Account Deletes an account of a managed machine or unmanaged machine. ssc machine-account delete < -uuid UUID -machine MachineName > -type ConnectionType < -uuid UUID -machine MachineName > -type ConnectionType Specify a UUID of a target machine or machine name. Specify a connection type. Only "oob" is supported. OOB is used for Out-of-Band-Management. >ssc machine-account delete -machine SV0100 -type oob >ssc machine-account delete -uuid 503BDAA8-19A1-793F-8A39-198D1EFEC439 -type oob 31

34 2 Command for Setup Displaying Machine Account Displaying information of an account of a managed machine or unmanaged machine. ssc machine-account show [< -uuid UUID -machine MachineName >] [-setting] [< -uuid UUID -machine MachineName >] Specify a UUID of a target machine or machine name. If you do not specify UUID or MachineName, all registered machines become targets. [-setting] Displays in the csv format. >ssc machine-account show >ssc machine-account show -setting >ssc machine-account show -machine SV0100 >ssc machine-account show -machine SV0100 -setting >ssc machine-account show -uuid 503BDAA8-19A1-793F-8A39-198D1EFEC439 >ssc machine-account show -uuid 503BDAA8-19A1-793F-8A39-198D1EFEC439 setting [Display examples] >ssc machine-account show [1] MachineName : SV0100 UUID :503BDAA8-19A1-793F-8A39-198D1EFEC439 MachineAccount UserName : user01 HostName : Connection Status : Connected [2009/06/09 13:00:00] 32 SigmaSystemCenter 2.1 SSC Command Reference

35 Machine Account [2] MachineName : SV0101 UUID : 555BDAA8-19A1-793F-8A39-198D1EFEEEEE MachineAccount UserName : user02 HostName : Connection Status : Connected [2009/06/09 13:15:00] >ssc machine-account show -setting MachineName,UUID,UserName,HostName,Connection Status SV0100,503BDAA8-19A1-793F-8A39-198D1EFEC439,user01, ,Connected [2009/06/09 13:00:00] SV0101,555BDAA8-19A1-793F-8A39-198D1EFEEEEE,user02, ,Connected [2009/06/09 13:15:00] >ssc machine-account show -machine SV0101 MachineName : SV0101 UUID : 555BDAA8-19A1-793F-8A39-198D1EFEEEEE MachineAccount UserName : user02 HostName : Connection Status : Connected [2009/06/09 13:15:00] >ssc machine-account show -uuid 555BDAA8-19A1-793F-8A39-198D1EFEEEEE MachineName : SV0101 UUID : 555BDAA8-19A1-793F-8A39-198D1EFEEEEE MachineAccount UserName : user02 HostName : Connection Status : Connected [2009/06/09 13:15:00] >ssc machine-account show -uuid 555BDAA8-19A1-793F-8A39-198D1EFEEEEE -setting MachineName,UUID,UserName,HostName,Connection Status SV0101,555BDAA8-19A1-793F-8A39-198D1EFEEEEE,user02, ,Connected [2009/06/09 13:15:00] 33

36 2 Command for Setup 2.7. Group Creating Group Creates a group. ssc create group GroupName [ modeltype ModelType] [-count Count] [-ostype OperatingSystemType] [-priority Priority] [-pool <group shared>] [-p Password] [-dpmweb DPMWebServer] [-dpmmanager DPMManager] [-vms VMSModelName] [-vnet VirtualNetworkName...] [-optimized] [-dc DatacenterName] [-prestriction] GroupName [ modeltype ModelType] [-count Count] Specify a group name to create. GroupName must be specified with a path to a group or model. (E.g. Category/Group, Category/Group/Model) NOTE: If there is an uncreated category in a path of a group, the category is created. In addition, a group in a path of a model must be an existing group. If you specify -ostype, a group is created and if you specify -modeltype, a model is created. Specify a model type that you configure to a model from the following types. ModelType: a model type "Physical": To create a Physical model "VM": To create a VM model "VMServer": To create a VM Server model You cannot omit this option to create a model. If you do not specify this option, a group is created. Specify the number of groups or models. Specify "1" or bigger. If you specify "2" or bigger, a serial number from 1 is added to GroupName. The default number is "1". 34 SigmaSystemCenter 2.1 SSC Command Reference

37 Group [-ostype OperatingSystemType] [-priority Priority] [-pool <group shared>] [-p Password] [-dpmweb DPMWebServer] [-dpmmanager DPMManager] [-vms VMSModelName] [-vnet VirtualNetworkName...] [-optimized] Specify an OS type. You cannot omit this option to create a group. You can specify one of the following OperatingSystemTypes: OperatingSystemType : An OS type "Linux": Linux "Linux-ipf": Linux for IPF "Windows-client": Windows Client "Windows-ipf": Windows Server for IPF "Windows": Windows Server Specify priority of a group or model. Specify from 1 to 10. The default priority is "1". Specify a search mode of a pool machine. You can specify this option only when you are to create a group. "group": To search only machines in a group pool. (GroupOnly) "shared": To search the shared pool if there is no machine in the group pool. (GroupAndShared) Specify an Administrator password. You can specify this option only when you are to create a group. Specify this option to use an administrator password configured to a group. Specify an IP address of Web Server for DPM. This option is enabled if the ModelType is VM. Specify an IP address of Management Server for DPM. This option is enabled if the ModelType is VM. Specify a VM Server model name. This option is enabled if the ModelType is VM. If there are multiple models with the same name, you cannot specify this option. Specify a virtual network name. This option is enabled if the ModelType is VM. You can specify up to four names divided by a space. NICs are assigned in the specified order from NIC #1. NOTE: Even if an error occurred in configuring a virtual network setting, a model is created. In that case, you need to configure a virtual network setting of the target model form the Web Console. Specify this option to enable Optimized Startup. This option is enabled if the ModelType is VM. 35

38 2 Command for Setup [-dc DatacenterName] [-prestriction] Specify a datacenter name. Specify a path of the Virtual view. This option is enabled if the ModelType is VMServer. (E.g. Virtual manager/datacenter) Enables the Optimized Placement Rule. If you do not specify this option, the setting of the Optimized Placement Rule is disabled. This option is enabled if the ModelType is VMServer. [Available options for each group type] Group (Model) Types Group to create Physical VM VM Server Options -ostype -count -priority -pool -p -modeltype -count -priority -modeltype -count -priority -dpmweb -dpmmanager -vnet -vms -optimized -modeltype -count -priority -dc -prestriction 36 SigmaSystemCenter 2.1 SSC Command Reference

39 Group >ssc create group Category1/Group001/model1 modeltype vm count 2 priority 3 vnet "VM Network" >ssc create group Category1/Group001/model2 modeltype vm dpmweb dpmmanager >ssc create group Category1/Group001/model3 modeltype vm vms VMServerModel optimized >ssc create group Group003 ostype windows count 2 >ssc create group Group003/model1 modeltype vmserver priority 4 >ssc create group Category1/Group01/VmsModel01 -modeltype VMServer -dc VC/Datacenter1 prestriction 37

40 2 Command for Setup Updating Group Setting You can edit or update a setting for a group with this command. ssc update group GroupName [-pool <group shared>] [-policy [PolicyName]] [-priority Priority] [-p Password] [-dpmweb [DPMWebServer]] [-dpmmanager [DPMManager]] [-vms [VMSModelName]] [-vnet [VirtualNetworkName...]] [-optimized <on off>] [-dc [DatacenterName]] [-vmoptimize <on off>] [-loadbound [low=value] [high=value] [dl=value] [du=value]] [-reserve ReserveMachineNumber] [-prestriction <on off>] [-domain name [account] [password]] [-dns [primary][secondary][tertiary]] 38 GroupName [-pool <group shared>] [-policy [PolicyName]] [-priority Priority] [-p Password] [-dpmweb [DPMWebServer]] [-dpmmanager [DPMManager]] Specify a group to update. Specify a path to the group or model. You cannot specify a category. (E.g. Category/Group, Group/Model) Specify a search mode of a pool machine. You can specify this option only when you are to create a group. "group": To search machines in a group pool. (GroupOnly) "shared": To search machines in the shared pool if a target machine cannot be found in the group pool. (GroupAndShared) Updates a policy name. If you do not specify PolicyName, the policy setting is not configured. Updates priority of a group or model. Specify from 1 to 10. Specify an Administrator password. This option is enabled when you specify a group in GroupName. Specify an IP address of Web Server for DPM. If you do not specify DPMWebServer, the setting is not configured. This option is enabled if a model type of GroupName is VM. Specify an IP address of Management Server for DPM. If you do not specify DPMManager, the setting is not configured. This option is enabled if a model type of GroupName is VM. SigmaSystemCenter 2.1 SSC Command Reference

41 Group [-vms [VMSModelName]] [-vnet [VirtualNetworkName...]] [-optimized <on off>] [-dc [DatacenterName]] [-vmoptimize <on off>] [-loadbound [low=value] [high=value] [dl=value] [du=value]] [-reserve ReserveMachineNumber] [-prestriction <on off>] Specify a model name of a virtual machine server. If you do not specify VMSModelName, the model name is not configured. This option is enabled if a model type of GroupName is VM. If there are multiple VM Server models with the same name, you cannot specify this option. Specify a virtual network name. This option is enabled if a model type of GroupName is VM. You can specify up to four names (from NIC#1 to NIC#4). This option deletes all configured settings and configures newly specified settings. You cannot add, edit, or delete configured settings. You need to configure a virtual network name that you do not intend to change. If you do not specify VirtualNetworkName, the virtual network name is not configured. Configures the Optimized Startup. This option is enabled if a model type of GroupName is VM. on: Enables the Optimized Startup. off: Disables the Optimized Startup. Specify a datacenter name. Specify a path of the Virtual view. (E.g. Virtual manager/datacenter) If you do not specify DatacenterName, the datacenter name is not configured. This option is enabled if a model type of GroupName is VM Server. Configures the Optimized Startup. This option is enabled if a model type of GroupName is VM Server. on: Enables the VM Optimized Startup. off: Disables the VM Optimized Startup. Configures load balance and power save of the VM Optimized Placement. Specify from 0 to 100 in value. You cannot specify a space in front and behind the equal ("="). You need to specify "low", "high", "dl", or "du". This option is enabled if a model type of GroupName is VM Server. "low": Specifies a low-load border. "high": Specifies a high-load border. "dl": Specifies a lower limit of activation target range. "du": Specifies an upper limit of activation target range. Specify the number of spare machines for the VM Optimized Placement. Specify from 0 to 9. This option is enabled if a model type of GroupName is VM Server. Configures the Optimized Placement Rule. This option is enabled if a model type of GroupName is VM Server. on: Enables the Optimized Placement Rule. off: Disables the Optimized Placement Rule. 39

42 2 Command for Setup [-domain name [account] [password]] [-dns [primary][secondary][tertiary]] Specify a domain (suffix) name. If your environment is Windows, specify account and password as well. Specify an IP address of a DNS server. [Available options for each group type] Group (Model) Types Group to update Physical VM VM Server Options -priority -pool -policy -p -priority -policy -priority -policy -dpmweb -dpmmanager -vnet -vms -optimized -priority -policy -dc -vmoptimize -loadbound -reserve -prestriction >ssc update group Category/group1 pool shared policy "PolicyName" >ssc update group Category/group1 priority 2 policy >ssc update group Category/group1/model priority 3 -vnet "VM Network" vms VMServerModel >ssc update group Category/group1/model dpmweb dpmmanager optimized on >ssc update group Category/group1/model vms dpmweb dpmmanager optimized off 40 SigmaSystemCenter 2.1 SSC Command Reference

43 Group Displaying Group Setting Displays a setting for a group. ssc show group GroupName [-group] [-model [ModelName...]] GroupName [-group] [-model] [ModelName ] Specify a group to display. Specify a path to the group. You cannot specify a category or model. (E.g. Category/Group) Displays contents of a group setting. Displays contents of a model setting. Specify a target model name. >ssc show group Category1/Group01 >ssc show group Group-A001 -group >ssc show group Group-B001 -model >ssc show group Group-B001 -model Model-B001 Model-B002 41

44 2 Command for Setup 2.8. Host Creating Host Creates a host in a group. ssc create host GroupName HostName [IPAddress SubNetMask [DefaultGateway] [-monitor]] [-hc HostCount] [-product ProductKey] [-p Password] GroupName HostName [IPAddress] [SubNetMask] [DefaultGateway] [-monitor] [-hc HostCount] Specify a group to which you are to create a host. Specify a path to the group. You cannot specify a category or model. (E.g. Category/Group, Group) Specify a host name that you are to create in a group. Specify an IP address to be configured to a host to create. This setting is configured to NIC #1. If you specify 2 or bigger in HostCount, an IP address with one added to the specified IP address is configured. You cannot omit this option if you specify SubNetMask, DefaultGateway, or -monitor. Specify a subnet mask of an IP address of a host to create. You need to specify IPAddress. If you specify IPAddress, you cannot omit this option. Specify a default gateway. You need to specify IPAddress. If you specify this option, IPAddress is configured as an IP address for management. You need to specify IPAddress. Specify the number of hosts to create in a group. If you specify 2 or bigger, a serial number from 1 is added to HostName. If you specify IPAddress, specify a value in the range that the IP address can be assigned. 42 SigmaSystemCenter 2.1 SSC Command Reference

45 Host [-product ProductKey] [-p Password] Specify a product key. If an OS type of a group is one of the following, you can specify this option. Windows Client / Windows Server for IPF / Windows Server Specify an Administrator password. Specify this option to use an administrator password configured to a Host Setting. If you do not specify this option, a password configured to a group is used. >ssc create host Category/group1 vmhost -hc monitor <An example of network setting configured to a host and a host to create> test1/group1 vmhost1 <-Host : IP address for management : Subnet mask : Default gateway vmhost : IP address for management : Subnet mask : Default gateway vmhost : IP address for management : Subnet mask : Default gateway >ssc create host Category/group1 vmhost4 -hc 3 product xxxxx-xxxxx-xxxxx-xxxxx-xxxxx p xyz 43

46 2 Command for Setup Updating Host You can edit or update a Host Setting. ssc update host GroupName HostName [-name NewHostName] [-product ProductKey] [-tag TagName] [-changegroup DestinationGroupName] [-p [Password]] GroupName HostName [-name NewHostName] [-product ProductKey] [-tag TagName] [-changegroup DestinationGroupName] [-p [Password]] Specify a group in which a host to edit or update exists. Specify a path to the group. You cannot specify a category or model. (E.g. Category/Group) Specify a host name to edit or update. Updates the contents of HostName setting to NewHostName. Updates a product key. If an OS type of a group is one of the following, the product key can be updated. Windows Client / Windows Server for IPF / Windows Server Updates tag. Moves a host between groups (virtual machine maintenance). You can specify this option only for virtual machines. Specify a destination group of HostName. This option updates contents of a Host Setting to make a host of a virtual machine running in a group move to other group. Specify a path to a model. The host needs to be running (a machine is assigned). You cannot specify this option along with the other options. (E.g. Category/Group/Model, Category/Group/Model) Specify a password to use an administrator password configured to a host. If you specify only -p, a setting is changed to use a password configured to a group. Specify this option by itself. You need to specify one of -name, -product, -tag, -p, or -changegroup. 44 SigmaSystemCenter 2.1 SSC Command Reference

47 Host Note: To move a host between groups (-changegroup), your environment must meet all the following conditions. Check a destination group, source group, and settings of a model before running the command: The model type of a source group and destination group is VM. The OS types and virtual network settings of a source group and destination group are the same. No host with the same name as a target exists in a destination group. No same virtual machine as a target virtual machine to be moved exists in a pool of the target destination model group. As the move of a host between groups is executed only by the database operation, storage, a load balancer, a network, power control, or a group in DPM is not moved. >ssc update host Category/group1 hostabc name host001 >ssc update host Category/group1 host001 tag Tag_host001 p >ssc update host Category/group1 host002 p abc01>ssc update host Category/group1 host002 product xxxxx-xxxxx-xxxxx-xxxxx-xxxxx >ssc update host Category/group1 host001 changegroup Category/group2/model02 45

48 2 Command for Setup Displaying Host Definition Displays a setting of host definition. ssc show host GroupName [HostName...] [-setting] GroupName [HostName...] [-setting] Specify a group of which Host Setting you are to display. Specify a path to the group. You cannot specify a category or model. (E.g. Category/Group, Group) Specify a target host name. Specify the displaying method. If you do not specify this option, information is displayed in the csv format. >ssc show host Category1/Group01 HOST-01 >ssc show host Group-A001 >ssc show host Group-B001 -setting 46 SigmaSystemCenter 2.1 SSC Command Reference

49 IP Address 2.9. IP Address Adding IP Address Information Adds IP address (network) to a host in a group. ssc add ipaddress GroupName HostName NicNumber IPAddress SubNetMask [DefaultGateway] [-monitor] [-hc HostCount] GroupName HostName NicNumber IPAddress SubNetMask [DefaultGateway] [-monitor] [-hc HostCount] Specify a group to which you are to add IP address information. Specify a path to the group. You cannot specify a category or model. (E.g. Category/Group, Group) Specify a name of a host to which you are to add an IP address. If you specify 2 or bigger in -hc, HostName must end with a number. Specify a target NIC number. Specify an IP address. One is added for the number of hosts to an IP address, starting from a specified IP address. You cannot omit this option if you specify SubNetMask, DefaultGateway, or -monitor. Specify a subnet mask. You need to specify IPAddress. Specify a default gateway. You need to specify IPAddress. If you specify this option, IPAddress is configured as an IP address for management. You need to specify IPAddress. Specify the number of hosts to create in a group, If you specify 2 or bigger, a serial number from 1 is added to HostName. If you specify IPAddress, specify a value in the range that the IP address can be assigned. 47