Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Command-Line Interfaces
- BBCTrustServer Command-Line Interface
- ConfigExchange Command-Line Interface
- ConfigExchangeSIS Command-Line Interface
- ConnectedServer Command-Line Interface
- ContentAutoUpload Command-Line Interface
- ContentManager Command–Line Interface
- ConfigWsTool Command-Line Interface
- opr-agt Command-Line Interface
- opr-archive-events Command-Line Tool
- Policy Management CLI workflows
- opr-assign Command-Line Interface
- opr-cert-mgmt Command-Line Interface
- opr-ci-list Command-Line Interface
- opr-close-events Command-Line Tool
- opr-config-tool Command-Line Interface
- opr-downtime Command-Line Interface
- opr-internal-tls-config Command-Line Interface
- opr-jobs Command-Line Interface
- opr-mp-installer Command-Line Interface
- opr-node Command-Line Interface
- opr-package-manager Command-Line Interface
- opr-script Command-Line Interface
- opr-sis-file-manager Command-Line Interface
- opr-template Command-Line Interface
- opr-tls-config Command-Line Interface
- opr-tool Command-Line Interface
- opr-user Command-Line Interface
opr-assign Command-Line Interface
The opr-assign command-line interface enables you to create, update, list, delete, disable and enable management template and aspect (automatic) assignments. You can create assignments for the latest version of an aspect or management template, or you can create an assignment for a specific aspect or management template version. Additionally, you can create automatic assignment rules by specifying the view name and management template or aspect ID.
Location
<OMi_HOME>/opr/bin/opr-assign.[bat|sh]
Synopsis
opr-assign -help|-version|<CONNECTION_INFO>|<operation>
-rc_file <file> &| -username <login name> [ -password <password> | -smartcard | -winCrypto | -jks <keystore path> -jksPassword <keystore password> ] [[-port <port>] [-server <gatewayserver>] [-ssl] | [-u <URL>]]
Note If <CONNECTION_INFO>
is omitted, the command is executed on the server to which you are logged on.
Option | Description |
---|---|
{-rc_file | -rcf }<file>
|
Location of your credential store. Values for your username, password, java keystore location, and java keystore password can be defined here, enabling you to run commands without having to specify the values individually each time. Use the options -list_rc , -set_rc , and -delete_rc to work with the file. The default file is <OMi_HOME>/.opr-cli-rc . If this option is not specified, then commands automatically check the default file location for credentials. You must specify this option if your credential store file is in a non-default location. If this file does not exist or does not contain the correct settings, you must manually specify the credentials using the other command options. |
{-list_rc| -lrc} [-rc_file <file>]
|
Display the content of the file from which credentials are read. The file contains fields for java keystore, keystore password, username and password, and is encrypted by a hardcoded key. |
{-set_rc | -src} <key>=<value> [-rc_file <file>]
|
Configure one setting in the file from which credentials are read. Specify the setting and the new value by using a key=value pair. For example, -set_rc password=<password string> . |
{-delete_rc | -drc} <setting> [-rc_file <file> }
|
Delete setting from file from which credentials are read. Possible settings are username, password, jks, and jksPassword. |
{-username|-user} <login name>
|
Sets the login name of the user required to execute CLI operations on the target gateway server. |
{-password|-pw} <password>
|
Sets the password for the specified user. If using SSH on Cygwin, either enter the password in free text or use other communication methods, for example Java keystore, Windows keystore, or smart card authentication. Default value: empty string |
{-smartcard|-sc}
|
Use certificate stored on smart card or security token for authentication. When OMi is configured to use CAC authentication, the CLI tools under For more information, see Using command-line tools when client certificate enforcement is used. |
{-winCrypto|-wc}
|
If OMi is configured for TLS mutual authentication, this option specifies to use the Windows certificate store for authentication. The certificate store must hold exactly one client certificate, which OMi will use to authenticate the user. This option is only available on Windows systems. For details, see Configure Client Certificate or Smart Card Authentication. |
{-jks|-j} <keystore path>
|
If OMi is configured for TLS mutual authentication, this option can be used to specify the Java keystore to be used for authentication. The keystore must hold exactly one client certificate, which OMi will use to authenticate the user. Note It is not necessary that the client certificate contains the flag "Smart Card Logon (1.3.6.1.4.1.311.20.2.2)" in the "Enhanced Key Usage" field. For details, see Configure Client Certificate or Smart Card Authentication. |
{-jksPassword|-jp} <keystore password>
|
Password for accessing the Java keystore. |
{-port|-p} <port>
|
Uses port Default: |
-server <GatewayServer>
|
Sets the target gateway server, using Default: FQDN of the OMi gateway server |
-ssl |
When this option is specified, the HTTPS protocol is used to connect to the target gateway server. If omitted, the HTTP protocol is used. Cannot be used in conjunction with the |
{-url|-u} <url> |
Sets the target gateway server, using Default: |
Options
opr-assign <CONNECTION_INFO>{
-list_auto_assignment <Auto Assignment ID> |
-list_auto_assignment_by_mgmt_template <Management Template ID> |
-list_auto_assignment_by_mgmt_template_version <Management Template Version ID> |
-list_auto_assignment_by_aspect <Aspect ID> |
-list_auto_assignment_by_aspect_version <Aspect Version ID |
-list_auto_assignment_by_view <View Name> }
[-output <path to output file>] [-verbose] [-filter_for_not_latest]
opr-assign <CONNECTION_INFO>{
-list_assignment [<Assignment ID>] |
-list_assignment_by_ci <CI ID> |
-list_assignment_by_mgmt_template <Management Template ID> |
-list_assignment_by_mgmt_template_version <Management Template Version ID> |
-list_assignment_by_aspect <Aspect ID> |
-list_assignment_by_aspect_version <Aspect Version ID |
-list_assignment_by_template <Template ID> |
-list_assignment_by_template_version <Template Version ID }
[-output <path to output file>] [-verbose]
opr-assign <CONNECTION_INFO>{
-get_draft_auto_assignment <View Name> <Management Template Version ID> |
-get_draft_auto_assignment_for_mgmt_template <View Name> <Management Template ID> |
-get_draft_auto_assignment_for_mgmt_template_version <View Name> <Management Template Version ID> |
-get_draft_auto_assignment_for_aspect <View Name> <Aspect ID> |
-get_draft_auto_assignment_for_aspect_version <View Name> <Aspect Version ID> |
-get_draft_assignment <CI ID> <Management Template Version ID> |
-get_draft_assignment_for_mgmt_template <CI ID> <Management Template ID> |
-get_draft_assignment_for_mgmt_template_version <CI ID> <Management Template Version ID> |
-get_draft_assignment_for_aspect <CI ID> <Aspect Version ID> |
-get_draft_assignment_for_aspect_version <CI ID> <Aspect Version ID> |
-get_draft_assignment_for_template <CI ID> <Template ID> |
-get_draft_assignment_for_template_version <CI ID> <Template Version Id> }
[-use_existing] [-output <path to output file>
opr-assign <CONNECTION_INFO> -create_auto_assignment -input <path to input file> [-output <path to output file>]
opr-assign <CONNECTION_INFO>{
-create_auto_assignment <View Name> <Management Template Version ID> |
-create_auto_assignment_by_mgmt_template <View Name> <Management Template ID> |
-create_auto_assignment_by_mgmt_template_version <View Name> <Management Template Version ID> |
-create_auto_assignment_by_aspect <View Name> <Aspect ID> |
-create_auto_assignment_by_aspect_version <View Name><Aspect Version ID }
{ [-enable] | [-disable] } [-parameter_value <Parameter (<name>=<value>)>]* [-output <path to output file>] [-format <valid values: xml | json>]
opr-assign <CONNECTION_INFO> -create_assignment -input <path to input file> [-output <path to output file>]
opr-assign <CONNECTION_INFO>{
-create_assignment <CI ID> -id <Management Template Version ID> |
-create_assignment_by_mgmt_template <CI ID> <Management Template ID> |
-create_assignment_by_mgmt_template_version <CI ID> <Management Template Version ID> |
-create_assignment_by_aspect <CI ID> <Aspect ID> |
-create_assignment_by_aspect_version <CI ID><Aspect Version ID |
-create_assignment_by_template <CI ID> <Template ID> |
-create_assignment_by_template_version <CI ID> <Template Version ID> }
{ [-enable] | [-disable] } [-parameter_value <Parameter (<name>=<value>)>]* [-output <path to output file>] [-format <valid values: xml | json>] [-list_parameter_values]
opr-assign <CONNECTION_INFO>{ -update_assignment -id <Assignment ID> | -update_auto_assignment -id <Auto Assignment ID> } { [-new_version <version no. (<major>.<minor>)>] | [-latest_version] } { [-enable] | [-disable] } [-parameter_value <Parameter (<name>=<value>)>]* [-output <path to output file>] [-format <valid values: xml | json | text>] [-list_parameter_values]
opr-assign <CONNECTION_INFO> -delete_auto_assignment -id <Auto Assignment ID>
opr-assign <CONNECTION_INFO> -delete_assignment -id <Assignment ID>
opr-assign <CONNECTION_INFO> -delete_assignment_by_ci <CI ID>
opr-assign <CONNECTION_INFO>{ -list_deployment_job [-id <Deployment Job ID>] | -list_deployment_job_by_assignment -id <Assignment ID>} [-output <path to output file>]
opr-assign <CONNECTION_INFO>{
-list_mgmt_template [<Management Template ID>] |
-list_mgmt_template_by_citype -ci_type <CI type name> |
-list_mgmt_template_by_ci <CI ID> |
-list_mgmt_template_by_view -view_name View Name> |
-list_mgmt_template_version [<Management Template Version ID>] }
[-output <path to output file>] [-format <valid values: xml | json | text>]
opr-assign <CONNECTION_INFO>{
-list_aspect [<Aspect ID>] |
-list_aspect_by_citype -citype <CI type name> |
-list_aspect_by_ci <CI ID> |
-list_aspect_by_view -view_name <View Name> |
list_aspect_version [<Aspect Version ID>] }
[-output <path to output file>] [-format <valid values: xml | json | text>]
opr-assign <CONNECTION_INFO>{ -list_template [<Template ID>] | -list_template_version <Template Version ID>} [-output <path to output file>]
Note For the Management Template ID, Management Template Version ID, Aspect ID, Aspect Version ID, Template ID, Template Version ID, and the Deployment Job ID, specify the UUID.
Option | Description |
---|---|
{-ca | -create_assignment} <CI ID> <Management Template Version ID> |
Creates or updates an assignment. You can specify an input file via Note The option to specify a CI ID and the Management Template Version ID exists for backward compatibility.The behavior is identical to |
{‑caa|-create_assignment_by_aspect} <CI ID> <Aspect ID> |
Creates an Aspect Version Assignment for the specified CI and the latest version of the aspect. |
{‑caav | -create_assignment_by_aspect_version} <CI ID> <Aspect Version ID>
|
Creates an Aspect Version Assignment for the specified CI and aspect version. |
{‑camt | -create_assignment_by_mgmt_template} <CI ID> <Management Template ID>
|
Creates a Management Template Version Assignment for the specified CI and the latest version of the Management Template. |
{‑camtv | -create_assignment_by_mgmt_template_version} <CI ID> <Management
Template Version ID>
|
Creates a Management Template Version Assignment for the specified CI and Management Template version. |
{-cat | -create_assignment_by_template} <CI ID> <Template ID>
|
Creates a Template Version Assignment for the specified CI and the latest version of the template. |
{‑catv | -create_assignment_by_template_version} <CI ID> <Template
Version ID>
|
Creates a Template Version Assignment for the specified CI and template version. |
{‑cau | -create_auto_assignment} <View Name> <Management Template Version ID>
|
Creates an Automatic Assignment. You can specify an XML or JSON input file via |
|
Creates an Automatic Assignment. You can specify an XML or JSON input file via |
|
Creates an Automatic Assignment. You can specify an XML or JSON input file via |
|
Creates an Automatic Assignment. You can specify an XML or JSON input file via |
|
Creates an Automatic Assignment. You can specify an XML or JSON input file via |
|
Deletes the assignment with the specified Assignment ID. |
|
Deletes all assignments for CI with the specified CI ID. |
{-dau | -delete_auto_assignment} <Auto Assignment ID>
|
Deletes the Management Template Version Auto Assignment or Aspect Version Auto Assignment with the specified Auto Assignment ID. |
{-dis | -disable}
|
Disables an (automatic) assignment. |
{-drc | -delete_rc} <setting>
|
Deletes the specified setting from the rc-file. Possible settings are username, password, jks, jksPassword. Example: '<command> -delete_rc password' |
{-en | -enable}
|
Enables an (automatic) assignment. |
{-f | -format} <xml | json | text>
|
Format of the input or output files associated with a web service request. Valid values are xml, json, and text. |
{-ffnl | -filter_for_not_latest}
|
Shows automatic assignments that do not have the latest version object. Use only in combination with the command to list automatic assignments. |
{-gda | -get_draft_assignment} <CI ID> <Management Template Version ID>
|
Returns a draft request that can be modified and used
to assign the Management Template Version with the specified version ID
to the CI
with the specified ID. This option is
identical to -get_draft_assignment_for_mgmt_template_version . |
{-gdaa | -get_draft_assignment_for_aspect} <CI ID> <Aspect ID>
|
Returns a draft request that can be modified and used to assign the Aspect with the specified ID to the CI with the specified ID. |
{-gdaav | -get_draft_assignment_for_aspect_version} <CI ID> <Aspect Version ID>
|
Returns a draft request that can be modified and used to assign the Aspect Version with the specified version ID to the CI with the specified ID. |
{-gdamt | -get_draft_assignment_for_mgmt_template} <CI ID> <Management Template ID>
|
Returns a draft request that can be modified and used to assign the Management Template with the specified ID to the CI with the specified ID. |
{-gdamtv | -get_draft_assignment_for_mgmt_template_version} <CI ID> <Management Template Version ID>
|
Returns a draft request that can be modified and used to assign the Management Template Version with the specified version ID to the CI with the specified ID. |
{-gdat | -get_draft_assignment_for_template} <CI ID> <Template ID>
|
Returns a draft request that can be modified and used to assign the Template with the specified ID to the CI with the specified ID. |
{-gdatv | -get_draft_assignment_for_template_version} <CI ID> <Template Version ID>
|
Returns a draft request that can be modified and used to assign the Template Version with the specified version ID to the CI with the specified ID. |
{-gdau | -get_draft_auto_assignment} <View Name> <Management Template Version ID>
|
Returns a draft to create a Management Template Version Automatic Assignment. Instead of the view name and Management Template Version ID, you can specify an XML or JSON input file via -input <path to input file> . |
{-gdaua | -get_draft_auto_assignment_for_aspect} <View Name> <Aspect ID>
|
Returns a draft to create an Aspect Automatic Assignment. Instead of the view name and Aspect ID, you can specify an XML or JSON input file via -input <path to input file> . |
{-gdauav | -get_draft_auto_assignment_for_aspect_version} <View Name> <Aspect Version ID>
|
Returns a draft to create an Aspect Version Automatic Assignment. Instead of the view name and Aspect Version ID, you can specify an XML or JSON input file via -input <path to input file> . |
{-gdaumt | -get_draft_auto_assignment_for_mgmt_template} <View Name> <Management Template ID>
|
Returns a draft to create a Management Template Automatic Assignment. Instead of the view name and Management Template ID, you can specify an XML or JSON input file via -input <path to input file> . |
{-gdaumtv | -get_draft_auto_assignment_for_mgmt_template_version} <View Name> <Management Template Version ID>
|
Returns a draft to create a Management Template Version Automatic Assignment. Instead of the view name and Management Template Version ID, you can specify an XML or JSON input file via -input <path to input file> . |
{-h | -help}
|
Displays the help and lists the available options. |
{-i | -input} <path to input file>
|
Input file for creating an assignment with the same structure as a
draft assignment returned by one of the
-get_draft_assignment options. |
{-la | -list_assignment} [<Assignment ID>]
|
Lists all assignments in the database. To return a single assignment, specify the Assignment ID. |
{-laa | -list_assignment_by_aspect} <Aspect ID>
|
Lists all Aspect Assignments for the aspect with the specified aspect ID. |
{-laav | -list_assignment_by_aspect_version} <Aspect Version ID>
|
Lists all Aspect Version Assignments for the aspect with the specified aspect version ID. |
{-laci | -list_assignment_by_ci} <CI ID>
|
Lists all assignments for the CI with the specified ID. |
{-lamt | -list_assignment_by_mgmt_template} <Management Template ID>
|
Lists all assignments of the Management Template with the specified ID. |
{-lamtv | -list_assignment_by_mgmt_template_version} <Management Template Version ID>
|
Lists all assignments of the Management Template Version with the specified version ID. |
{-lasp | -list_aspect} [<Aspect ID>]
|
Lists all aspects in the database. To return a single aspect, specify the Aspect ID. |
{-laspci | -list_aspect_by_ci} <CI ID>
|
Lists all aspects that can be assigned to the CI with the specified ID. |
{-laspcit | -list_aspect_by_ci} <CI type name>
|
Lists all aspects that can be assigned to CIs of the specified CI type. |
{-laspv | -list_aspect_version} [<Aspect Version ID>]
|
Lists all versions of all aspects in the database. To return a single aspect version, specify the Aspect Version ID. |
{-laspvi | -list_aspect_by_view} <View Name>
|
Lists all aspects for the specified view. |
{-lat | -list_assignment_by_template} <Template ID>
|
Lists all Template Assignments for the template with the specified Template ID. |
{-latv | -list_assignment_by_template_version} <Template Version ID>
|
Lists all Template Version Assignments for the template version with the specified Template Version ID. |
{-lau | -list_auto_assignment} [<Auto Assignment ID>]
|
Lists all Management Template Version Auto Assignments. To return a single automatic assignment, specify the Auto Assignment ID. |
{-laua | -list_auto_assignment_by_aspect} [<Aspect ID>]
|
Lists all Aspect Auto Assignments for the aspect with the specified Aspect ID. |
{-lauav | -list_auto_assignment_by_aspect_version} [<Aspect Version ID>]
|
Lists all Aspect Version Auto Assignments for the aspect version with the specified Aspect Version ID. |
{-laumt | -list_auto_assignment_by_mgmt_template} [<Management Template ID>]
|
Lists all Management Template Auto Assignments for the Management Template with the specified ID. |
{-laumtv | -list_auto_assignment_by_mgmt_template_version} [<Management Template Version ID>]
|
List all Management Template Version Auto Assignments for the Management Template Version with the specified ID. |
{-lauvi | -list_auto_assignment_by_view} <View Name>
|
Lists all Auto Assignments for the specified view. |
{-ldj | -list_deployment_job} [<Deployment Job ID>]
|
Lists the deployment jobs for all current assignments. To return a single deployment job, specify the Deployment Job ID. |
{-ldja | -list_deployment_job_by_assignment} <Assignment ID>
|
Lists the deployment jobs for the assignment with the specified ID. |
{-lmt | -list_mgmt_template} [<Management Template ID>]
|
Lists all Management Templates in the database. To return a single management template, specify the Management Template ID. |
{-lmtci | -list_mgmt_template_by_ci} <CI ID>
|
Lists all Management Templates that can be assigned to the CI with the specified ID. |
{-lmtcit | -list_mgmt_template_by_citype} <CI type name>
|
Lists all Management Templates that can be assigned to CIs of the specified CI type. |
{-lmtv | -list_mgmt_template_version} <Management Template Version ID>
|
Lists all versions of all Management Templates in the database. To return a single Management Template Version, specify the Management Template Version ID. |
{-lmtvi | -list_mgmt_template_by_view} <View Name>
|
Lists all Management Templates for the specified view. |
{-lpv | -list_parameter_values} <View Name>
|
Lists all parameter values. |
{-lt | -list_template} [<Template ID>]
|
Lists all templates in the database. To return a single template, specify the Template ID. |
{-ltv | -list_template_version} [<Template Version ID>]
|
Lists all versions of all templates in the database. To return a single template version, specify the Template Version ID. |
{-lv | -latest_version}
|
By using this argument, the (Automatic) Assignment is updated to the the latest version. |
{-nv | -new_version} <version>>
|
By using this argument, the (Automatic) Assignment is updated to the specified version. |
{-o | -output} <path to output file>>
|
When specified, the response returned by a web service request is saved to the specified file. |
{-pv | -parameter_value} <Parameter (<name>=<value>)>
|
Specifies the parameter to be set. |
{-ua | -update_assignment} <Assignment ID>
|
Updates the assignment with the specified Assignment ID. |
{-uaa | -update_auto_assignment} <Auto Assignment ID>
|
Updates the automatic assignment with the specified Auto Assignment ID. |
{-ue | -use_existing}
|
Takes over parameter values (if compatible) from an already existing assignment to the new assignment. The existing and the new assignment must refer to the same CI and the same template/aspect/MT, but must refer to different template/aspect/MT versions. Parameters are not compatible if, for example, the parameter type changed from string to password between versions. |
{-ulau | -update_latest_auto_assignment}
|
Update all automatic assignments to the latest version. |
{-v | -verbose}
|
Print verbose output. |
-version
|
Print the version information and exit. |
Usage
Use opr-assign, opr-config-tool and opr-template together for an end-to-end CLI policy management workflow. For details, see Policy Management CLI workflows.
Restrictions
Non-admin users also need the following file permissions to operate this command-line tool:
File | Windows Permissions | Linux Permissions |
---|---|---|
<OMi_HOME>/conf/TopazInfra.ini |
read | r |
<OMi_HOME>/log/opr-clis.log |
full control | rw |
Note: This file is not available on gateway server systems.
|
full control | rw |
<OMi_HOME>/conf/encryption.properties |
read | r |
<OMi_HOME>/conf/seed.properties |
read | r |
Examples
-
List all assignments:
opr-assign -list_assignment
-
List all auto assignment rules:
opr-assign -list_auto_assignment_rule
-
Create an assignment for an aspect version for a specific CI:
opr-assign -create_assignment_by_aspect_version -id <Aspect Version ID> -ci_id <CI ID>
-
Delete a specific assignment:
opr-assign -delete_assignment -id <Assignment ID>
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: