cfgsvc command

Purpose

Configures an agent or service specified by the given name.

Syntax

cfgsvc AgentName [-attr Attribute=Value... | -ls | -key]

Description

The cfgsvc command configures the agent or service specified, by the given name. Use the lssvc command to obtain a list of agents or services. After configuring the agent or service, you can start and stop the agent or service by using the startsvc and stopsvc commands. Each time you run the command, it overwrites previous configurations.

To find the values for required attributes for an agent or service, use the -ls flag. If you do not specify a required attribute when you specify this command, a message is displayed that indicates the missing required attribute.

Agents might create ssh keys as part of their configuration. You can display the ssh public key that is generated during configuration by using the -key flag.

Parameters

Flag name	Description
-attr Attribute=Value	Identifies an attribute and value that are associated with the configuration of an agent or service.
-ls	Lists all the attributes that can be changed for a particular agent or service configuration.
-key	Displays the ssh public key that is generated for a particular agent or service configuration. Note: The -key flag is not valid for the Tivoli® Storage Productivity Center.

Agent or service names

The following agents or services can be managed by the Virtual I/O Server.

Agent or service name	Description
ITM_premium ITM_cec	Attribute names for the IBM® Tivoli Monitoring (ITM) agents The ITM_premium and ITM_cec agents provide system information including I/O virtualization mappings and system utilization. These agents require that you specify the HOSTNAME attribute for configuration. Also, an ssh public key is generated if one does not exist. HOSTNAME Provides the monitoring agent with a Tivoli Enterprise Management System (TEMS) host name. This is a required attribute. Valid values are: Host name IP address RESTART_ON_REBOOT Designates whether the monitoring agent is started if the Virtual I/O Server is rebooted. Because you can run only one monitoring agent on the Virtual I/O Server at any given time, configuring more than one monitoring agent to restart is only valid for the last agent that is configured to restart. Run the lssvc command by using the ITM agent name to verify which agent restarts. Valid values are: True False MIRROR Provides the monitoring agent with a secondary Tivoli Enterprise Management System (TEMS) host name. This is an optional attribute. Valid values are: Host name IP address managing_system Provides the monitoring agent with a Hardware Management Console (HMC) host name. This attribute is not valid for the Integrated Virtualization Manager. Valid values are: [user_name@]Host name IP address second_managing_system Provides the monitoring agent with a secondary Hardware Management Console (HMC) host name. This attribute is not valid for the Integrated Virtualization Manager. This attribute is available for the ITM_cec agent. This is an optional attribute. Valid values are: [user_name@]Host name IP address CEC Provides the ITM_cec agent with a CEC host name.
TPC	Attribute names for the TotalStorage Productivity Center agents The TPC agent is a TotalStorage Productivity Center agent. This agent requires that you specify the S, A, devAuth, and caPass attributes for configuration. By default, specifying this agent configures both the TPC_data and TPC_fabric agents. S Provides the TotalStorage Productivity Center agent with a TotalStorage Productivity Center server host name. This a required configuration attribute. The valid values are: Host name IP address A Provides the TotalStorage Productivity Center agent with an agent manager host name. This is a required attribute. The valid values are: Host name IP address devAuth Sets the TotalStorage Productivity Center device server authentication password. This is a required attribute. The valid value is: Password caPass Sets the CA authentication password. This is a required attribute. The valid value is: Password caPort Sets the CA port. This is an optional attribute. The default value is 9510. The valid value is: Number amRegPort Specifies the agent manager registration port. This is an optional attribute. The default value is 9511. The valid value is: Number amPubPort Specifies the agent manager public port. This is an optional attribute. The default value is 9513. The valid value is: Number dataPort Specifies the TotalStorage Productivity Center data server port. This is an optional attribute. The default value is 9549. The valid value is: Number
	devPort Specifies the TotalStorage Productivity Center device server port. This is an optional attribute. The default value is 9550. The valid value is: Number newCA This is an optional attribute. The default value is true. The valid values are: True False oldCA This is an optional attribute. The default value is true. The valid values are: True False daScan This is an optional attribute. The default value is true. The valid values are: True False daScript This is an optional attribute. The default value is true. The valid values are: True False daInstall This is an optional attribute. The default value is true. The valid values are: True False faInstall This is an optional attribute. The default value is true. The valid values are: True False U Specifies to uninstall the agent. This is an optional attribute. The valid values are: All \| data \| fabric
perfmgr	Attribute names for the performance management data collector agent: see the postprocesssvc command.
ipsec_tunnel	ipsec_tunnel works as a service on the Virtual I/O Server. Configurable parameters are as follows: local_ip The IP address of the source Virtual I/O Server. remote_ip The IP address of the destination Virtual I/O Server. key The key value consists of alphanumeric characters only.
ILMT	The IBM License Metric Tool (ILMT) agent helps the License Metric Tool to identify the system on the network to determine which IBM software is installed. It requires the server attribute to be configured with the host name or IP of the ILMT server. server The host name or IP address of the message handler server. security_level The security level for the agent communication. port The port number used by the agent if the security_level parameter equals 0. secure_port The port number used by the agent if the security_level parameter equals 1. client_auth_secure_port The port number used by the agent if the security_level parameter equals 2. scan_group The name of the scan group, which is only used for the initial registration with the server. use_proxy Whether the agent is protected by a proxy server. Valid values are y and n. proxy_port The port number used by the proxy server. The default value is 3128. proxy The address of the proxy server. fips_enabled Whether the agent uses the Federal Information Processing Standard (FIPS). Valid values are y and n. trace_size The maximum size of a single iteration of the agent trace file. trace_level The level of trace that is logged during operation of the agent. The default level, MIN, is enough to identify the cause of most problems. MID or MAX trace levels can be enabled if a problem occurs whose cause cannot be immediately identified. trace_files The maximum number of iterations of the agent trace file. If the trace file reaches the maximum size defined in the trace_size parameter, the remaining messages roll over to another iteration of the file. The trace_files parameter defines how many times it can occur. msglog_files The number of message log files. msglog_size The maximum size of the message log. tivoli_common_dir The path to Tivoli Common Directory. userdata1 The custom data about agents.

Examples

IBM Tivoli Monitoring

To list all the attributes that are associated with an agent configuration, type the command as follows:
```
cfgsvc -ls ITM_premium
```
To configure the ITM_premium agent with several attributes, type the command as follows:
```
cfgsvc ITM_premium -attr Restart_On_Reboot=TRUE hostname=tems_server
managing_system=hmc_console 
```
Note: When the RESTART_ON_REBOOT attribute is set to TRUE, the ITM agent is restarted when the Virtual I/O Server is being rebooted. The hostname attribute specifies the Tivoli Enterprise Monitoring Server (TEMS) IP address, or hostname is set to tems_server. The managing_system attribute specifies the HMC IP address, or hostname is set to hmc_console.
To display the ITM_premium agent ssh public key, type the command as follows:
```
cfgsvc -key ITM_premium
```

IBM TotalStorage Productivity Center

To list all TotalStorage Productivity Center configurable attributes, type the command as follows:
```
cfgsvc TPC -ls
```
To configure TotalStorage Productivity Center with mandatory attributes, type the command as follows:
```
cfgsvc TPC -attr S=tpc_server_hostname
A=agent_manager_hostname devAuth=password caPass=password
```

ipsec tunnels

To list all the attributes associated with the service configuration, type the command as follows:
```
cfgsvc -ls ipsec_tunnel
```

To configure ipsec_tunnel, type the command as follows:

cfgsvc ipsec_tunnel -attr local_ip=1.2.3.4 remote_ip=2.1.4.3 key=abcd1234

IBM License Metric Tool (ILMT)

To list all IBM License Metric Tool (ILMT) attributes, type the command as follows:
```
cfgsvc ILMT -ls
```
To configure ILMT, type the command as follows:
```
cfgsvc ILMT -attr server=1.2.3.4
```

Related Information

The lssvc command, the postprocesssvc command, the startsvc command, and the stopsvc command.

For more information about the various agents, see the following information:

Last updated: Wed, November 18, 2020