Installing Agents Manually
Use these procedures to manually install a Sun xVM Ops Center agent, and to register the target system with Sun Inventory.
Before You Begin
To supply the agentadm command arguments that these procedures require, you need the following information:
- Administrative user name on the Enterprise Controller
Configuring a Sun xVM Ops Center agent using user credentials requires using an administrative user account that exists on the Sun xVM Ops Center Enterprise Controller. This user account provides authentication that supports agent registration. You use this user name as the argument for the agentadm -u option. - Password for the administrative user name on the Enterprise Controller
If you use user credentials to configure your Sun xVM Ops Center agent, you use this password to populate the /var/tmp/xVM/mypasswd file. You then use this file name as the argument for the agentadm -p option. - The auto-reg-token registration token from the /var/opt/sun/xvm/persistence/scn-proxy/connection.properties file on the appropriate proxy controller
If you decide not to use user credentials to configure your agent software, you use this token to populate the /var/tmp/xVM/mytoken file. You then use this file name as the argument for the agentadm -t option. - IP address or host name of the Proxy Controller with which you will associate the agent
You use this IP address or host name as the argument for the agentadm -x option. Typically you would choose to associate the agent with the Proxy Controller that is connected to the same subnet as the target system. - The IP address of the network interface that the agent will use for registration.
You use this IP address as the argument for the agentadm -a option.
Some example agentadm commands in this procedure use the alternative administrative user name droot. In these examples, the droot user exists on the Enterprise Controller associated with this example Sun xVM Ops Center installation.
Check with Sun Support Services for the following items:
- Patches to apply to the Sun xVM Ops Center software
- Updated Sun xVM Ops Center agent bundles
Sun Support Services might have Sun xVM Ops Center patches or updated agent bundles that might be required before you install agent software.
To Manually Install a Sun xVM Ops Center Agent
To manually install a Sun xVM Ops Center agent, you must:
- Transfer an agent software bundle to the system where you want the agent to run
- Install the agent software
- Configure the agent software
Use To Transfer and Install Agent Software to transfer an agent bundle from the Enterprise Controller to the target system, and install the agent software.
Use either To Configure Agent Software Using User Credentials or To Configure Agent Software Using a Token to configure the agent software, depending on your site security requirements.
To Transfer and Install Agent Software
- On the Sun xVM Ops Center Enterprise Controller, change to the /var/opt/sun/xvm/images/agent directory, and list the files that it contains.
This directory contains the Sun xVM Ops Center agent installation archives. For example:
# cd /var/opt/sun/xvm/images/agent/ # ls SunConnectionAgent.Linux.i686.2.1.0.870.zip SunConnectionAgent.SunOS.i386.zip SunConnectionAgent.Linux.i686.2.1.0.870.zip.sig SunConnectionAgent.SunOS.i386.zip.sig SunConnectionAgent.Linux.i686.zip SunConnectionAgent.SunOS.sparc.2.1.0.870.zip SunConnectionAgent.Linux.i686.zip.sig SunConnectionAgent.SunOS.sparc.2.1.0.870.zip.sig SunConnectionAgent.SunOS.i386.2.1.0.870.zip SunConnectionAgent.SunOS.sparc.zip SunConnectionAgent.SunOS.i386.2.1.0.870.zip.sig SunConnectionAgent.SunOS.sparc.zip.sig # - Identify the agent archive that is appropriate for the system where you intend to install the agent.
The symbolic links named SunConnectionAgent.SunOS.sparc.zip, SunConnectionAgent.SunOS.i386.zip, and SunConnectionAgent.Linux.i686.zip point to the latest Sun xVM Ops Center agent archive for Solaris SPARC, Solaris x86, and Linux x86 systems, respectively. For example, to identify the latest Sun xVM Ops Center agent archive for Solaris SPARC systems, use the ls command to show the archive to which the appropriate link points:
# ls -l SunConnectionAgent.SunOS.sparc.zip lrwxrwxrwx 1 root root 44 Apr 2 19:27 SunConnectionAgent.SunOS.sparc.zip -> SunConnectionAgent.SunOS.sparc.2.1.0.870.zip #
- On the system where you want to install the agent (the target system), create a directory named /var/tmp/xVM.
# mkdir /var/tmp/xVM - Use scp or ftp to transfer the correct agent archive from the Sun xVM Ops Center Enterprise Controller to the /var/tmp/xVM directory on the target system.
Respond to any authentication or confirmation prompts that are displayed. For example:
# scp SunConnectionAgent.SunOS.sparc.2.1.0.870.zip root@10.5.241.74:/var/tmp/xVM Password: SunConnectionAgent.S 100% |*********************************************************************| 34695 KB 00:32 # - On the target system, change to the /var/tmp/xVM directory.
# cd /var/tmp/xVM # - Use the unzip command to uncompress the agent archive.
For example:
# unzip SunConnectionAgent.SunOS.sparc.2.1.0.870.zip (output omitted)
- Run the install -a script in the SunConnectionAgent directory.
For example:
# SunConnectionAgent/install -a Installing xVM Ops Center Agent. No need to install 120900-04. No need to install 121133-02. No need to install 119254-63. No need to install 119042-09. No need to install 121901-02. No need to install 137321-01. Installed SUNWjdmk-runtime. Installed SUNWjdmk-runtime-jmx. (output omitted) 6 patches skipped. 19 packages installed. Installation complete. Detailed installation log is at /var/scn/install/log. Uninstall using /var/scn/install/uninstall. #
To Configure Agent Software Using User Credentials
This procedure creates a file that holds the password of the administrative user for your xVM Ops Center installation. If you prefer to avoid creating this file, use To Configure Agent Software Using a Token instead of this procedure to configure your agent software.
- Create an empty file named /var/tmp/xVM/mypasswd, and set its permission mode to 400.
For example:
# touch /var/tmp/xVM/mypasswd # chmod 400 /var/tmp/xVM/mypasswd
- Edit the /var/tmp/xVM/mypasswd file so that it contains the password for the administrative user that exists on the Enterprise Controller to which the Proxy Controller is connected.
The following echo command appends the password to the /var/tmp/xVM/mypasswd file. Replace password with the correct password. For example:
# echo 'password' > /var/tmp/xVM/mypasswd - Use the agentadm command to associate the Sun xVM Ops Center agent with the Sun xVM Ops Center Proxy Controller.
- Solaris OS: Use the /opt/SUNWxvmoc/bin/agentadm command.
- RHEL OS: Use the /opt/sun/xvmoc/bin/agentadm command.
The example commands below use the following options:configure – Causes an agent configuration operation to take place.
-u – Specifies the administrative user that exists on the Enterprise Controller to which the Proxy Controller is connected. Be certain that the password that you specified in the /var/tmp/xVM/mypasswd file is correct for the user that you specify for this option. Note: The example below uses droot as the administrative user.
-p – Specifies the absolute path name of the file that contains the password for the user that you specified with the -u option.
-x – Specifies the IP address or host name of the Sun xVM Ops Center Proxy Controller to which this agent will connect.
-a – Specifies the IP address to use during agent registration. This selects the network interface that the agent will use for registration.
Accept the server's certificate when prompted. For example:# /opt/SUNWxvmoc/bin/agentadm configure -u droot -p /var/tmp/xVM/mypasswd -x 172.20.26.218 agentadm: Version 1.0.3 launched with args: configure -u droot -p /var/tmp/xVM/mypasswd -x 172.20.26.218 workaround configuration done. Certificate: Serial Number: 947973225 Version: 3 Issuer: CN=flyfishing_scn-proxy_ca Subject: CN=flyfishing_scn-proxy_agent Not valid before: Thu Jun 19 15:36:59 MDT 1969 Not valid after: Thu Apr 19 15:36:59 MDT 2029 Certificate: Serial Number: 1176469424 Version: 3 Issuer: CN=flyfishing_scn-proxy_ca Subject: CN=flyfishing_scn-proxy_ca Not valid before: Thu Jun 19 15:36:56 MDT 1969 Not valid after: Thu Apr 19 15:36:56 MDT 2029 Accept server's certificate? (y|n) y Connection registered successfully. scn-agent configuration done. Checking if UCE Agent process is still running, it may take a couple of minutes ... Process is no longer running UCE Agent is stopped. UCE Agent is in [online] state. Checking if UCE Agent process is up and running ... The process is up and running. UCE Agent is started. Added the zone configuration automation successfully. Added the service tags recreate script successfully. #
Connection cannot be registered error messages similar to the following example typically indicate problems with the user credentials that you specified in the agentadm command. In this example, the user droot was not authenticated on the Sun xVM Ops Center Enterprise Controller. If you see an error like this, check that the user name that you supplied for the agentadm -u option, and the password in the file that you specified for the agentadm -p option, match an existing administrative user on the Enterprise Controller.
Accept server's certificate? (y|n) y Error with connection to CRS: com.sun.scn.connmgt.SCNRegClientException: droot, Code: 4, Code: 4 ERROR : Connection cannot be registered. Code--2 sc-console registration failed on [2]. sc-console : User authentication error. Error executing step : sc_console
If the system where you are installing the agent has multiple active network interfaces, you can use the -a option to specify the IP address of the interface that you want to use for agent registration. For example:
# /opt/SUNWxvmoc/bin/agentadm configure -u droot -p /var/tmp/xVM/mypasswd -x 172.20.26.218 -a 172.20.26.128 (output omitted)
- If you encountered a Connection cannot be registered error message from the agentadm command, use agentadm to unconfigure the agent. For example:
# /opt/SUNWxvmoc/bin/agentadm unconfigure agentadm: Version 1.0.3 launched with args: unconfigure verified sc_console command is OK End of validation {output omitted} End of configuration.
After the agent has been unconfigured, correct the problem that was indicated by the error message, and re-run the agentadm configure command. - Use the sc-console command to list the agent connection.
For example:
# sc-console list-connections scn-agent https://172.20.26.218:21165 urn:scn:clregid:a860a6d4-6899-4bcc-9ac7-a6ebaf71c1f5:20090420171121805 #
To Configure Agent Software Using a Token
This procedure uses a token to configure your xVM Ops Center agent software. If you prefer to use user credentials for this purpose, use To Configure Agent Software Using User Credentials instead of this procedure to configure your agent software.
- On the Proxy Controller that will communicate with this agent instance, examine the /var/opt/sun/xvm/persistence/scn-proxy/connection.properties file.
The last line in this file lists the auto-reg-token token that is required for agent registration. For example:
# cat /var/opt/sun/xvm/persistence/scn-proxy/connection.properties #Generated by a program. Do not edit. All manual changes subject to deletion. (output omitted) trust-store=/var/opt/sun/xvm/security/jsse/scn-proxy/truststore auto-reg-token=5b51bd9f-1700-450d-b038-ece0f9482474\:1271743200000\:T #
- On the system where you have installed the Sun xVM Ops Center agent software, create an empty file named /var/tmp/xVM/mytoken, and set its permission mode to 400.
For example:
# touch /var/tmp/xVM/mytoken # chmod 400 /var/tmp/xVM/mytoken
- Edit the /var/tmp/xVM/mytoken file so that it contains the auto-reg-token token string from Proxy Controller, with the following changes:
- Replace auto-reg-token with autoregToken.
- Remove any backslash characters from the token string.
For example:
autoregToken=5b51bd9f-1700-450d-b038-ece0f9482474:1271743200000:T
- Use the agentadm command to associate the Sun xVM Ops Center agent with the a xVM Ops Center Proxy Controller.
- Solaris OS: Use the /opt/SUNWxvmoc/bin/agentadm command.
- RHEL OS: Use the /opt/sun/xvmoc/bin/agentadm command.
The example commands below use the following options:configure – Causes an agent configuration operation to take place.
-t – Specifies the absolute path name of the file that contains the registration token.
-x – Specifies the IP address or host name of the Sun xVM Ops Center Proxy Controller to which this agent will connect.
-a – Specifies the IP address to use during agent registration. This selects the network interface that the agent will use for registration.
Accept the server's certificate when prompted. For example:# /opt/SUNWxvmoc/bin/agentadm configure -t /var/tmp/xVM/mytoken -x 172.20.26.218 agentadm: Version 1.0.3 launched with args: configure -t /var/tmp/xVM/mytoken -x 172.20.26.218 workaround configuration done. Certificate: Serial Number: 947973225 Version: 3 Issuer: CN=flyfishing_scn-proxy_ca Subject: CN=flyfishing_scn-proxy_agent Not valid before: Thu Jun 19 15:36:59 MDT 1969 Not valid after: Thu Apr 19 15:36:59 MDT 2029 Certificate: Serial Number: 1176469424 Version: 3 Issuer: CN=flyfishing_scn-proxy_ca Subject: CN=flyfishing_scn-proxy_ca Not valid before: Thu Jun 19 15:36:56 MDT 1969 Not valid after: Thu Apr 19 15:36:56 MDT 2029 Accept server's certificate? (y|n) y Connection registered successfully. scn-agent configuration done. Checking if UCE Agent process is still running, it may take a couple of minutes ... Process is no longer running UCE Agent is stopped. UCE Agent is in [online] state. Checking if UCE Agent process is up and running ... The process is up and running. UCE Agent is started. Added the zone configuration automation successfully. Added the service tags recreate script successfully. #
If the system where you are installing the agent has multiple active network interfaces, you can use the -a option to specify the IP address of the interface that you want to use for agent registration. For example:
# /opt/SUNWxvmoc/bin/agentadm configure -t /var/tmp/xVM/mytoken -x 172.20.26.218 -a 172.20.26.128 (output omitted)
- If you encountered a Connection cannot be registered error message from the agentadm command, use agentadm to unconfigure the agent. For example:
# /opt/SUNWxvmoc/bin/agentadm unconfigure agentadm: Version 1.0.3 launched with args: unconfigure verified sc_console command is OK End of validation {output omitted} End of configuration.
After the agent has been unconfigured, correct the problem that was indicated by the error message, and re-run the agentadm configure command. - Use the sc-console command to list the agent connection.
For example:
# sc-console list-connections scn-agent https://172.20.26.218:21165 urn:scn:clregid:a860a6d4-6899-4bcc-9ac7-a6ebaf71c1f5:20090420171121805 #
Registering the Target System
Manually installing a Sun xVM Ops Center agent causes the target system to be listed in the Managed Gear tab as a managed system, but it does not automatically register the target system with Sun Inventory. To register the target system, perform the following steps:
- Select Gear from the Navigation panel in the Sun xVM Ops Center BUI.
- Select the All Gear item.
The Register Gear action item is displayed in the Actions list. - Select the Register Gear action.
The Introduction panel of the Register Gear Wizard is displayed. - Click Next.
The Select Gear panel is displayed. - In the Select Gear panel, select the system that you want to register.
- Click Next.
The Register Gear panel is displayed. - Click Register to register the system.
A message is displayed that identifies the job that was started to register gear. Click Close to exit the Register Gear wizard.
Where to Go From Here
To learn how to configure your Enterprise Controller to receive software updates, see Configuring an Enterprise Controller for Updates (Optional).
To learn how to uninstall Sun xVM Ops Center software, see Uninstalling Sun xVM Ops Center Software.
Comments (2)
Jul 27
giorgios says:
Hi, I think that a couple of point in the doc should be revisited into "To Conf...Hi,
I think that a couple of point in the doc should be revisited into "To Configure Agent Software Using User Credentials"
1) First one is related to providing a password into a file.The instruction says:
It seems that it's necessary to append a _ before and after the password.
2) The example of command given is:
/opt/SUNWxvmoc/bin/agentadm configure -u droot -p /var/tmp/xVM/mypasswd -x 172.20.26.218
where a user droot is used. This is misleading because the d could be considered an option before the root username.
I would suggest to change droot with root or to clearly specify in advance that droot account will be used.
HTH
ciao
giorgio
Jul 27
L_Hartman says:
Hi Giorgio, Thanks for taking the time to provide feedback and suggestions. Gr...Hi Giorgio,
Thanks for taking the time to provide feedback and suggestions.
Great feedback. We'll reword the example and add more clarity.
Laura Hartman