ovpmutil

The tool ovpmutil.exe enables you to perform some configuration tasks from the command line. The tool can be used to do the following:
DEP (/p | /pn | /pg) <policyname> (/n | /np | /ng) <nodename> [/c <checkversion>][/e <enable>][/t <type>][/v <version>][(/user /pass ) | /client]
Description Deploys policies or policy groups on one or more managed nodes.
/p | /pn | /pg This required parameter indicates what is deployed. Use /p to indicate a policy with a full policy group path, /pn to indicate a policy without a path (only policy name), or /pg to indicate a policy group.
<policyname> This required parameter indicates the name of the policy or policy group to be deployed. For /pn, it is only the name of the policy without full policy group path. Otherwise, it must contain the path to the policy as shown in the console tree, starting under Policy groups. The path must begin with a backslash (\). Policy groups within the path are separated with a backslash, but may not end with a backslash. If the name of a policy group contains spaces, the entire path must be enclosed in quotation marks. For example, you may want to distribute a policy named disk_monitor found in a policy group named "Server Policies":

The correct syntax would be:
ovpmutil dep /p "\Server Policies\disk_monitor" mynode
/n | /np | /ng

This required parameter indicates the target type for deployment. Use /n to indicate a node, /np to indicate a node with a primary node name, or /ng to indicate a node group.

<nodename> This required parameter indicates the name of the node or node group on which the policy will be deployed. For /np, it is only the primary node name without the full node group path. Otherwise, it must contain the path to the node, as shown in the console tree, starting under Nodes. Use /n to indicate a node, or /ng to indicate a node group. All node groups within the path must be preceded with a backslash (\), but may not end with a backslash. If the name of a node group contains spaces, the entire path must be enclosed in quotation marks.
/c <checkversion> If this optional parameter is set to FALSE, no version check is made, and the policy is deployed even if a newer version of that policy is already deployed on the node. If the parameter is TRUE (or absent), the policy is deployed only if no newer version of the policy is deployed on the node.
/e <enable> If this optional parameter is set to FALSE, the policies are disabled on the node after deployment . If this parameter is TRUE (or absent), the policy or policy group is enabled after deployment.
/t <type> If this optional parameter is set, the policy is deployed only if it is a policy of the given policy type . You may use only the original English names. You must enclose the names quotation marks (for example, "Logfile Entry" or "Windows Management Interface"). This parameter is not valid when a policy group is deployed.
/v <version> If this optional parameter is set, the policy is deployed only if it matches the given version. This parameter is not valid when a policy group is deployed.
/use <username> Use this optional parameter to select the name of the account used to access the remote node. You can specify the account as a user principal name (UPN), such as User@Domain, or in the down-level log-on name format (Domain\User).
/pass <password> The password of the account used to access the remote node. Use this option only together with the /user option.
/client This optional parameter indicates that the deployment job should run under the security context of the specified user that is impersonated.
PCV [/x]|[/c [/v <version>][/n <name>][/i]][/e <encoding>]][<filenamelist> | /d <dirnamelist>]
Description Converts downloaded policy files (structured storage files) into a header stream (*.header) containing the policy management information (for example, name, version, LogicalID, InstanceID, and Checksum) and the data stream (*.data) containing the policy definition. The purpose of this functionality is to convert the policy from HPOM for Windows format (structured storage file) to HPOM for UNIX format(*.data file), and vice versa.
/x This optional parameter indicates that the command should extract the structured policy store from <filenamelist> or <dirnamelist>, which are lists of policy files (downloaded using ovpmutil CFG DNL) to be converted. You can extract multiple structured storage files by listing them separated with a space or by specifying them with directories of policy files separated with a space (/d option). You can specify the policy file list with <filenamelist> or <dirnamelist>.
/c This optional parameter indicates that the command should combine the *.header and *.data files into a structured policy store. <filenamelist> and <dirnamelist> have the same format as for /x.
/v <version> This optional parameter changes the version information of the policy to <version> during combination. (The InstanceID and Checksum are also updated.) Use this option only together with the /c option.
/n <name> This optional parameter changes the name given to the policy. (The new LogicalID, InstanceID, is created and Checksum is updated). Use this option only together with the /c option.
/i This optional parameter indicates that just the InstanceID (and Checksum) information of the policy is updated. If you do not specify it, and the Checksum does not match the data stream, an error is generated. Use this option only together with the /c option.
/e <encoding> This optional parameter indicates that policy *.data files are converted from selected to UTF-8 encoding, and then combined into a structured policy store. Use this option to convert a policy file that is not encoded in UTF-8 or ASCII. Supported encodings are ASCII, UTF-8, ISO81, ISO82, ISO85, ROMAN8, SJIS, EUCJP, GB2312, BIG5, EUCTW, and EUCKR. Default is UTF-8. Use this option only together with the /c option.
<filenamelist>

This optional parameter is a list of policy file names to be converted. The policy that is a structured storage is extracted into the header stream (*.header) containing the policy management information (for example, name, version, LogicalID, InstanceID, and Checksum) and the data stream (*.data) containing the policy definition. If you do not use this parameter, you must use /d <dirnamelist>. File names must not include file extensions.

/d <dirnamelist>

This optional parameter is a list of directories with policy files to be converted. All policy files located on directories in the list are converted to the appropriate format. If you do not use this parameter, you must use <filenamelist>.

REG POL <PolicyFileName>[/g <PolicyGroupPath>] [/pid <ProductId>]
Description Registers policies (in the form of structured storage files) on the management server.
<PolicyFileName> This required parameter indicates the name of the policy file to be registered.
/g <PolicyGroupPath> This optional parameter indicates the group to which the policy should be added. If no group is given, the policy is visible only under Policies grouped by Type. The path must begin with a backslash (\). The policy groups within the path are separated with a backslash (\). If the name of a policy group contains spaces, the entire path must be enclosed in quotation marks. If the policy group does not exist, the command creates it.
/pid <ProductId> This optional parameter allows you to specify the product ID of a licensed OV product. If you supply this parameter, the policy is enabled only if the product is licensed on the management server. If you do not supply the parameter, the policy functions without any license check.
UNREG POL <PolName> <PolVersion> <PTName> <PTVersion>
Description Unregisters policies on the management server. This operation is carried out only if the policy is currently not deployed on any managed node.
<PolName> This required parameter indicates the name of the policy as it appears in the console.
<PolVersion> This required parameter indicates the version of the policy. The format is n.m, where 0 ≤ n ≤ 9999 and 0 ≤ m ≤ 9999.
<PTName> This required parameter indicates the original English name of the policy type of the policy.
<PTVersion>  This required parameter indicates the version of the policy type. The format is n.m, where 0 ≤ n ≤ 9999 and 0 ≤ m ≤ 9999.
CFG <conftype> (UPL <configfilename> [/noautodeploy]) | (DNL <configfilename> [ (/a) | (/p <identifier> [/configuredonly | /externalonly]) | (/excludenodes) | (/fqdn <nodeFQDN> | /ip <nodeIP>) ] | (([/writable][/migration]) | [/changed]) | (RMV <configfilename>)
Description Uploads or downloads the policy, service, user role, node, tool, service type, message group, or policy, package node inventory, and agent profile configuration.
<conftype> This required parameter indicates what the command should upload or download. Valid choices are:
  • POL = policy configuration of all policies in a group
  • SVC = service configuration
  • TLS = tools configuration
  • NDS = node configuration
  • USR = user roles
  • PPN = policy and package node inventory
  • XML = service configuration in HP Operations Manager for UNIX XML format
  • SVT = service type configuration
  • MSG = message group configuration
  • CIV = configuration values
  • MDL = combines SVC, SVT, TLS, NDS, and MSG options
  • ALL = combines MDL, POL, USR, PPN, and CIV options
UPL <configfilename> This optional parameter indicates that the command should upload the management configuration file designated by the file <configfilename>. The <configfilename> designates the location and name of the management configuration file to be uploaded or downloaded (for example, c:\test\dnl-svc.mof or c:\tmp\config.mm). Uploading data in HP Operations Manager for UNIX XML format and upload agent profile operations are not supported.
/noautodeploy This optional parameter is valid only for the node configuration upload (NDS | MDL | ALL) UPL option. If you do not specify it, the property DisableAutoDeployment is set to true for all imported nodes.
DNL <configfilename> This optional parameter indicates that the command should download the configuration specified in the <configtype> parameter, and save it in the directory designated by <configfilename>. The name can include a drive letter and a path. If you do not specify a path, the file is written to the current directory.

For conftype SVC, TLS, NDS, SVT, MSG, and CIV, <configfilename> indicates the name and location of the downloaded mof file. For conftype XML and PPN, it indicates the name and location of a downloaded XML file. For conftype POL, it indicates the directory for the downloaded mm file and the downloaded structured storage policy files. For conftype PRF, it indicates the directory for the downloaded agent profile file.

Note NOTE:
For conftype NDS and SVT, only associations to tools, policy groups, and deployment packages (plus reports and graphs for NDS) are downloaded, not objects themselves (which must be downloaded manually).

Although all types of policies can be downloaded, only the following policies can be imported into HP Operations Manager for UNIX:

  • Logfile Entry policy type
  • Open Message Interface policy type
  • Windows Event Log policy type
  • SNMP Interceptor policy type
  • Scheduled Command policy type
/a This optional parameter is valid only for policy configuration download. If it is specified, all policy versions (assigned to the policy group or not) are downloaded and stored in a specified directory with one mm file. You cannot use this parameter when /p is specified.
/p <identifier> This optional parameter is only valid for configuration download.

For policies, the identifier is a path from which policies are downloaded recursively. It must contain the path to the policy, as shown in the console tree, starting under Policy groups. The path must begin with a backslash (\). Policy groups within the path are separated with a backslash (\). If the name of a policy group contains spaces, the entire path must be enclosed in quotation marks. If you do not specify the path, all policy groups are downloaded (each in its own subdirectory with its own mm file).

You cannot use this parameter when /a is specified. For services, the parameter is the service ID of the top-level service of the sub-tree to be downloaded.

For tools, nodes, or XML configurations, this parameter is the unique id of the item at which the recursive enumeration begins. It defaults to the respective root item.

For message groups, this parameter specifies the message group ID. If you do not specify this parameter, all message groups are downloaded.

For user roles, this parameters specifies the user role ID. If you do not specify this parameter, all user roles are downloaded.

/excludenodes This optional parameter is valid only with the DNL MDL option. It indicates that the node information should not be downloaded.
/configuredonly This optional parameter is valid only with the DNL NDS option. It indicates that only the configuration of configured nodes (nodes with defined OS) should be downloaded.
/externalonly This optional parameter is valid only with the DNL NDS option. It indicates that only the configuration of external nodes should be downloaded.
/fqdn <nodeFQDN> This optional parameter enables you to specify a Fully Qualified Domain Name (FQDN) of the node for which the agent profile should be generated.
/ip <nodeIP> This optional parameter enables you to specify an IP address of the node for which the agent profile should be generated.
/writable This optional parameter is valid only with the DNL CIV option. It indicates that only writable configuration values should be downloaded.
/migration This optional parameter is valid only with the DNL CIV option. It indicates that only configuration values relevant for migration of configuration to another HPOM for Windows server should be downloaded.
/changed This optional parameter is valid only with the DNL CIV option. It indicates that only modified configuration values should be downloaded.
RMV <configfilename> Not valid for end-user operations.
DNL PRF ( (([/fqdn <FQDN>][/ip <IP>]) | [/nid <ID>]) [/d <dir>] ) | PKG ( <PackName> [PackVersion] [/d <dir>] ( /nid <ID> | /pnn <PrimaryNodeName> | (/ost <OSType> /osv <OSVersion> /abf <AgtBinFormat>) ) )
Description Downloads the agent profile (PRF option) or package binaries (PKG option) for manual installation.
/nid <ID> This optional parameter enables you to specify an ID of the node that is already managed by the management server.
/d <dir> This optional parameter specifies the directory where the agent profile or package binaries are downloaded. If you do not specify this parameter, the current directory is used.
PRF This parameter indicates that the command should download the agent profile for the manual agent installation for the specified node.
/fqdn <FQDN> This optional parameter enables you to specify a Fully Qualified Domain Name (FQDN) of the node for which the agent profile should be generated.
/ip <IP> This optional parameter enables you to specify an IP address of the node for which the agent profile should be downloaded.
PKG This parameter indicates that the command should download package binaries for manual package installation on the specified node or on a specified platform.
<PackName> This required parameter indicates the name of the package you want to download.
<PackVersion> This optional parameter indicates the version of the package you to download. The format is n.m.o, where 0 <= n,m,o <= 9999.
/ppn <PrimaryNodeName> This optional parameter enables you to specify the primary node name of the node that is already managed by the management server.
/ost <OSType> This optional parameter enables you to specify the OS version of a target platform. Use this parameter together with /osv and /abf.
/osv <OSVersion> This optional parameter enables you to specify the OS version of a target platform. Use this parameter together with /ost and /abf.
/abf <AgtBinFormat> This optional parameter enables you to specify the binary format of agent bits for deployment on a target platform. Use this parameter together with /ost and /osv.

Samples

ovpmutil cfg civ dnl c:\test\dnl-civ.mof
ovpmutil cfg civ dnl c:\test\dnl-civ.mof /migration /changed
ovpmutil cfg civ upl c:\test\dnl-civ.mof
ovpmutil cfg mdl dnl c:\test\dnl-mdl.mof /excludenodes
ovpmutil cfg mdl upl c:\test\dnl-mdl.mof
ovpmutil cfg msg dnl c:\test\dnl-msg.mof /p <MessageId>
ovpmutil cfg msg upl c:\test\dnl-msg.mof
ovpmutil cfg nds dnl c:\test\dnl-nds.mof /p Root_Nodes
ovpmutil cfg nds dnl c:\test\dnl-ext.mof /p Root_Nodes /externalonly
ovpmutil cfg nds dnl c:\test\dnl-cfg.mof /p Root_Nodes /configuredonly
ovpmutil cfg nds upl c:\test\dnl-nds.mof
ovpmutil cfg pol dnl c:\test /p \Samples
ovpmutil cfg pol upl c:\test\config.mm
ovpmutil cfg pol rmv c:\test\config.mm
ovpmutil cfg ppn dnl c:\test\dnl-ppn.xml /p Root_Nodes
ovpmutil cfg ppn upl c:\test\dnl-ppn.xml
ovpmutil cfg prf dnl c:\test /fqdn nodename.hp.com
ovpmutil cfg svc dnl c:\test\dnl-svc.mof /p Root_Services
ovpmutil cfg svc upl c:\test\dnl-svc.mof
ovpmutil cfg svt dnl c:\test\dnl-svt.mof /p root
ovpmutil cfg svt upl c:\test\dnl-svt.mof
ovpmutil cfg tls dnl c:\test\dnl-tls.mof /p Root_Tools
ovpmutil cfg tls upl c:\test\dnl-tls.mof
ovpmutil cfg usr dnl c:\test\dnl-user-roles.xml /p Windows-admin
ovpmutil cfg usr upl c:\test\dnl-user-roles.xml
ovpmutil cfg xml dnl c:\test\dnl-xml.xml /p Root_Services
ovpmutil dnl prf /fqdn <nodename.hp.com>
ovpmutil dnl prf /nid <NodeId> /d "c:\test"
ovpmutil dnl pkg <PkgName> 8.50.10 /ost Solaris /osv 9 /abf SPARC
ovpmutil dnl pkg /nid <NodeId> /d "c:\test"

Examples

Example 1
To download a policy and convert it to text (HPOM for UNIX) format:

  1. Download the policies in the policy group Server Policies to the test directory on the C drive

    ovpmutil CFG POL DNL c:\test /p "\Server Policies"

  2. Extract a downloaded structured storage file to a text header and data file:

    ovpmutil PCV /x "C:\test\disk_monitor_CC832F49-A8BC-11D3-A45F-080009DC628C"

  3. Combine the header and data file into a structured policy storage file that can be uploaded on the management server:

    ovpmutil PCV /c "C:\test\disk_monitor_CC832F49-A8BC-11D3-A45F-080009DC628C"

Example 2
To deploy all policies in the policy group Server Policies to the node parsnip, even if a newer version is already deployed on the node:

ovpmutil DEP /pg "\Server Policies" /n "\email servers\parsnip" /c FALSE