This chapter provides an overview of the commands available in Resource Orchestrator.
Five types of commands are available: the login command, the resource operation commands, the image operation command, the control and environment setup commands, and the maintenance commands.
Login Command
rcxlogin
Resource Operation Commands
rcxadm chassis
rcxadm netconfig
rcxadm netdevice
rcxadm server (rcxserver) (*)
Image Operation Command
rcxadm image (rcximage) (*)
Control and Environment Setup Commands
deployment_service_uninstall
rcxadm agtctl
rcxadm authctl
rcxadm certctl
rcxadm dbctl
rcxadm deployctl
rcxadm eventctl
rcxadm imagemgr
rcxadm lanctl
rcxadm license
rcxadm mgrctl
rcxadm servermgr
rcxadm storagemgr
macbindconfig
Backup and restore the configuration definition information of Resource Orchestrator Commands
rcxbackup
rcxkeydefbackup
rcxkeydefrestore
rcxrestore
scwbackup
scwrestore
Maintenance Commands
inst_collectinfo
* Note: rcxserver and rcximage are abbreviated forms of the rcxadm server and rcxadm image commands. They both produce exactly the same results as their counterparts.
User accounts with administrative privileges within the operating system have access to all commands.
When using Windows, the OS administrator is an Administrator account. The rcxadm command can only be used from an Administrator account.
For user accounts that do not have administrative privileges within the operating system, it is necessary to first log into Resource Orchestrator as a privileged user with the login command. This will grant access to the resource operation, control and environment setup (only rcxadm mgrctl snap -all), and image operation command.
For details on privileged users, refer to "Chapter 5 Managing User Accounts" in the "User's Guide VE".
The table below lists the permissions required to execute each command depending on the server on which they are executed.
Command | Function | Required Privileges | Location | |||
---|---|---|---|---|---|---|
OS Administrator | Resource Orchestrator Privileged User | Admin Server | Managed Server | |||
Uninstallation of the related services | Yes | - | Yes | Yes | ||
Agent control | Yes | - | No | Yes | ||
User authentication directory service operations | Yes | - | Yes | No | ||
SSL certificate operations | Yes | - | Yes | Yes | ||
Chassis power control | - (*) | Yes | Yes | No | ||
Management of the database for Resource Orchestrator | Yes | - | Yes | - | ||
Encryption of license information definition files | Yes | - | No | Yes | ||
Event control | - (*) | Yes | Yes | No | ||
Image operations (backup and restore, cloning) | - (*) | Yes | Yes | No | ||
Image management settings | Yes | - | Yes | No | ||
Network parameter configuration | Yes | - | No | Yes | ||
License control | Yes | Yes | Yes | No | ||
Manager control | "snap -all" | - (*) | Yes | Yes | No | |
All except "snap -all" | Yes | - | ||||
Network device batch operations | Yes | - | Yes | No | ||
Network device operations | Yes | - | Yes | No | ||
Managed server control | - (*) | Yes | Yes | No | ||
Server management software operations | ||||||
ESC registration and deletion | - (*) | Yes | Yes | No | ||
Bind settings for MAC addresses | Yes | - | No | Yes | ||
Backup of configuration definition information | Yes | Yes | Yes | No | ||
Backup of other definition and management information | Yes | Yes | Yes | No | ||
Restoration of other definition and management information | Yes | Yes | Yes | No | ||
Logs in to Resource Orchestrator | - | - | Yes | No | ||
Restoration of configuration definition information | Yes | Yes | Yes | No | ||
Backup of image files | Yes | Yes | Yes | No | ||
Restoration of image files | Yes | Yes | Yes | No | ||
Collecting investigation data during installation | Yes | - | Yes | No |
Yes: Can be used
No: Cannot be used
-: Not required
* Note: This command can also be executed by a user with administrative privileges within the operating system. However, if the same user executes this command after logging into Resource Orchestrator, the operating system privileges will be replaced by Resource Orchestrator privileges. To use this command when logged into Resource Orchestrator, administrative privileges for Resource Orchestrator are required.
Information
Executing privileged commands within a script requires the user to be logged in with administrative privileges within the operating system. Otherwise, the rcxlogin -save command should first be run to grant access to privileged commands from scripts.
Refer to "2.1 rcxlogin" for details.
If, in Windows Server 2008 or later, a user account with administrative privileges that does not have the user ID "Administrator" starts up a command prompt from the menu, commands executed in that prompt cannot be executed with administrative privileges.
Right-click the command prompt in the menu, select [Run as administrator] from the displayed menu to start up the command prompt, and run the required command from there.
Point
Commands available on the admin server are all located under the following folder.
[Windows Manager]
Installation_folder\SVROR\Manager\bin
In Systemwalker Resource Coordinator VE V13.2 and VE V13.3, when using commands under the following folder within the created batch file, they must be changed to the specified folders, because the folder configuration for Resource Orchestrator is different.
Installation_folder\Site Manager\opt\FJSVrcxmr\bin
[Linux Manager]
/opt/FJSVrcvmr/bin